com.day.cq.dam.scene7.api

Interface Scene7Service

public interface Scene7Service

The Scene7Service provides methods for interacting with the official Scene7 API.

Field Summary

Fields

Modifier and Type	Field and Description
static int	CONTAINER Scene7 specification used in getAssociatedAssets - Array of set and template assets containing the specified asset.
static int	DERIVED Scene7 specification used in getAssociatedAssets - Array of assets that are derivatives of the specified asset.
static int	GENERATED Scene7 specification used in getAssociatedAssets - Array of assets that were generated from the specified asset.
static int	GENERATOR Scene7 specification used in getAssociatedAssets - Array of assets that were used to generate the specified asset.
static int	MEMBER Scene7 specification used in getAssociatedAssets - Array of assets contained by the specified set or template asset.
static int	OWNER Scene7 specification used in getAssociatedAssets - Array of assets that own the specified asset.

Method Summary

Modifier and Type	Method and Description
String	addUser(S7Config s7Config, String firstName, String lastName, String email, String defaultRole, String password, org.joda.time.Instant passwordExpires, boolean isValid, List<Scene7CompanyMembership> membershipArray) Creates a user account and adds the account to one of more companies
String	createFolder(S7Config s7Config, String cqFolderPath) Create a folder on Scene7 server
String	createImageSet(S7Config s7Config, String imageSetFolder, String imageSetName, String thumbAssetHandle) Create an ImageSet asset on Scene7 server
String	createViewerPreset(S7Config s7Config, String folderHandle, String name, String type, List<Scene7ConfigSetting> configSettings) Create a preset view to determine what users can see.
String	deleteAsset(String assetHandle, S7Config s7Config) Returns a String success/ failure,, note that the underlying S7 API call does not provide a data response.
String	deleteFolder(String folderHandle, S7Config s7Config) Returns a String success/ failure,, note that the underlying S7 API call does not provide a data response.
void	deleteImageFormat(S7Config s7Config, String imageFormatHandle) Deletes an image format.
void	deleteImageMap(S7Config s7Config, String imageMapHandle) Deletes an image map
List<Scene7User>	getAllUsers(S7Config s7Config, boolean includeInvalid) Return all users
String	getApplicationPropertyHandle(S7Config s7Config) Returns the application property handle.
List<Scene7Asset>	getAssets(String[] assetHandles, String[] responseFields, String[] excludeFields, S7Config s7Config) Returns a Scene7Asset list, based on a list of asset handles
Scene7Asset	getAssociatedAssets(Scene7Asset asset, S7Config s7Config) Retrieves the sub-assets and the origiator asset associated with the given asset
String	getCompanyMembership(ResourceResolver resourceResolver, String userHandle, String email, String password, String region) Returns a JSON representation of the company membership information provided by Scene7.
String	getFlashTemplatesServer(S7Config s7Config) Retrieves the server used for serving and manipulating flash templates, depending on the Scene7 configuration.
String	getFolderHandle(String cqFolderPath, S7Config s7Config) Returns s7 folder handle for the associated cq folder
Scene7Folder	getFolderTree(String folderPath, int depth, String[] responseFields, String[] excludeFields, S7Config s7Config) Returns a Scene7Folder holding a tree structure
String	getFxgServer(S7Config s7Config) Retrieves the server handling FXG rendering.
List<Scene7ImageFormat>	getImageFormats(S7Config s7Config) Returns image formats, such as PDF, EPS, SWF, and others.
List<String>	getImagePresets(S7Config s7Config) Returns a list of Scene7 image preset names for the given S7Config
List<String>	getJobLogDetails(String jobHandle, S7Config s7Config) Returns a list of Scene7 asset handles(Strings) for the given job handle
Scene7Asset	getMasterAsset(Scene7Asset asset, S7Config s7Config) Retrieves the originator asset associated with the given asset
ArrayList<UploadJobDetail>	getMultiFileJobLogDetails(String jobHandle, S7Config s7Config) Returns an Arraylist of job details objects
List<Scene7PropertySet>	getPropertySets(String typeHandle, S7Config s7Config) Returns the video encoder preset type handle.
String	getPublishServer(S7Config s7Config) Returns the domain name of the S7 publish server
String	getUserHandle(ResourceResolver resourceResolver, String email, String password, String region) Returns a unique user handle from Scene7.
List<Scene7User>	getUsers(S7Config s7Config, Boolean includeInactive, Boolean includeInvalid, List<String> companyHandleArray, List<String> groupHandleArray, List<String> userRoleArray, String charFilterField, String charFilter, String sortBy, Integer recordsPerPage, Integer resultsPage) Return a optionally sorted, filtered and paged list user results
String	getVideoEncoderPresetTypeHandle(S7Config s7Config) Returns the video encoder preset type handle.
Scene7ViewerConfig	getViewerConfigSettings(S7Config s7Config, String assetHandle) Get the viewer configuration for the referenced asset
boolean	isJobActiveByJobHandle(String jobHandle, S7Config s7Config)
boolean	isJobActiveByOriginalName(String originalName, S7Config s7Config)
String	saveImageFormat(S7Config s7Config, String imageFormatHandle, String name, String urlModifier) Create an image format.
String	saveImageMap(S7Config s7Config, String assetHandle, String imageMapHandle, String name, String shapeType, String region, String action, int position, boolean enabled) Create a new image map or edit an existing map
List<Scene7Asset>	searchAssets(String folder, Boolean includeSubfolders, Boolean published, String[] assetTypes, String[] assetSubTypes, String[] responseFields, String[] excludeFields, int recordsPerPage, int resultsPage, S7Config s7Config) Retrieves a list of Scene7Assets from the Scene7 server.
List<Scene7Asset>	searchAssets(String folder, Boolean includeSubfolders, Boolean published, String[] assetTypes, String[] assetSubTypes, String[] responseFields, String[] excludeFields, S7Config s7Config) Retrieves a list of Scene7Assets from the Scene7 server.
List<Scene7Asset>	searchAssetsByFilename(String folder, Boolean includeSubfolders, Boolean published, String filename, S7Config s7Config) Retrieve a list of Scene7Assets from the Scene7 server by filename.
List<Scene7Asset>	searchAssetsByMetadata(String folder, Boolean includeSubfolders, String[] assetTypes, String[] assetSubTypes, Boolean published, MetadataCondition[] conditions, int recordsPerPage, int resultsPage, S7Config s7Config) Returns a DOM list with search results (from metadata), support specify
List<Scene7Asset>	searchAssetsByMetadata(String folder, Boolean includeSubfolders, String[] assetTypes, String[] assetSubTypes, Boolean published, MetadataCondition[] conditions, S7Config s7Config) Returns a DOM list with search results (from metadata)
List<Scene7Asset>	searchAssetsByName(String folder, Boolean includeSubfolders, Boolean published, String name, S7Config s7Config) Retrieve a list of Scene7Assets from the Scene7 server by Scene7 asset name.
String	setAssetPublishState(Resource resource, boolean markForPublish, S7Config s7Config) Set the publish state of a given Scene7 asset
String	setAssetPublishState(String assetHandle, boolean markForPublish, S7Config s7Config) Set the publish state of a given Scene7 asset
List<String>	setImageMaps(S7Config s7Config, String assetHandle, List<Scene7ImageMapDefinition> imageMap) Sets the image map for an asset.
void	setUserInfo(S7Config s7Config, String userHandle, String firstName, String lastName, String email, String defaultRole, org.joda.time.Instant passwordExpires, boolean isValid, List<Scene7CompanyMembership> membershipArray) Set user attributes
void	setViewerConfigSettings(S7Config s7Config, String assetHandle, String name, String type, List<Scene7ConfigSetting> configSettings) Attach viewer configuration settings to an asset Can be viewer preset or the source asset for the viewer
void	updateImageSet(S7Config s7Config, String imageSetAssetHandle, List<String> setMemberHandles, String thumbAssetHandle) Update an ImageSet asset on Scene7 server
void	updateViewerConfigSettings(S7Config s7Config, String assetHandle, List<Scene7ConfigSetting> configSettings) Updates SWF viewer configuration settings.

Field Detail

CONTAINER

static final int CONTAINER

Scene7 specification used in getAssociatedAssets - Array of set and template assets containing the specified asset.

See Also:

Constant Field Values

MEMBER

static final int MEMBER

Scene7 specification used in getAssociatedAssets - Array of assets contained by the specified set or template asset.

See Also:

Constant Field Values

OWNER

static final int OWNER

Scene7 specification used in getAssociatedAssets - Array of assets that own the specified asset.

See Also:

Constant Field Values

DERIVED

static final int DERIVED

Scene7 specification used in getAssociatedAssets - Array of assets that are derivatives of the specified asset.

See Also:

Constant Field Values

GENERATOR

static final int GENERATOR

Scene7 specification used in getAssociatedAssets - Array of assets that were used to generate the specified asset.

See Also:

Constant Field Values

GENERATED

static final int GENERATED

Scene7 specification used in getAssociatedAssets - Array of assets that were generated from the specified asset.

See Also:

Constant Field Values

Method Detail

getPublishServer

String getPublishServer(S7Config s7Config)

Returns the domain name of the S7 publish server

Parameters:

s7Config -

Returns:

A string

getApplicationPropertyHandle

String getApplicationPropertyHandle(S7Config s7Config)

Returns the application property handle.

Parameters:

s7Config - the Scene7 configuration

Returns:

the application property handle

getVideoEncoderPresetTypeHandle

String getVideoEncoderPresetTypeHandle(S7Config s7Config)

Returns the video encoder preset type handle.

Parameters:

s7Config - the Scene7 configuration

Returns:

the video encoder preset type handle

getPropertySets

List<Scene7PropertySet> getPropertySets(String typeHandle,
                                        S7Config s7Config)

Returns the video encoder preset type handle.

Parameters:

typeHandle - - the type handle

s7Config - the Scene7 configuration

Returns:

the list of property sets

getUserHandle

String getUserHandle(ResourceResolver resourceResolver,
                     String email,
                     String password,
                     String region)

Returns a unique user handle from Scene7.

Parameters:

resourceResolver - resource resolver used to access Scene7 configuration

email - E-Mail address

password - Password

region - Region of the Scene7 service

Returns:

A unique user handle

getCompanyMembership

String getCompanyMembership(ResourceResolver resourceResolver,
                            String userHandle,
                            String email,
                            String password,
                            String region)

Returns a JSON representation of the company membership information provided by Scene7. The information includes a company handle, a company name and an asset root path.

For example:
{
handle: 'jlkj98',
name: 'Acme Ltd.',
rootPath: '/MyAssets'
}

Parameters:

resourceResolver - resource resolver used to access Scene7 configuration

userHandle - Unique user handle

email - E-Mail address

password - Password

region - Region of the Scene7 service

Returns:

A JSON string

getFolderTree

Scene7Folder getFolderTree(String folderPath,
                           int depth,
                           String[] responseFields,
                           String[] excludeFields,
                           S7Config s7Config)

Returns a Scene7Folder holding a tree structure

Parameters:

folderPath - - the top folder of the request - does not need to be the root.

depth - - depth of the returned folder tree.

responseFields - - fields to be filled in for each node in the tree

excludeFields - - fields to be excluded in each node of the tree

s7Config -

Returns:

A Scene7Folder object containing the requested folder structure

getFolderHandle

String getFolderHandle(String cqFolderPath,
                       S7Config s7Config)

Returns s7 folder handle for the associated cq folder

Parameters:

cqFolderPath - - the path the target cq folder targeted in the s7 folder organization

s7Config -

Returns:

folder handle or null if the folder does not exist in s7.

deleteFolder

String deleteFolder(String folderHandle,
                    S7Config s7Config)

Returns a String success/ failure,, note that the underlying S7 API call does not provide a data response.

Parameters:

folderHandle - - folder to be deleted

s7Config - - s7 config based on cloud service config info.

Returns:

String success / failure

deleteAsset

String deleteAsset(String assetHandle,
                   S7Config s7Config)

Returns a String success/ failure,, note that the underlying S7 API call does not provide a data response.

Parameters:

assetHandle - - asset to be deleted

s7Config - - s7 config based on cloud service config info.

Returns:

String success / failure

searchAssetsByMetadata

List<Scene7Asset> searchAssetsByMetadata(String folder,
                                         Boolean includeSubfolders,
                                         String[] assetTypes,
                                         String[] assetSubTypes,
                                         Boolean published,
                                         MetadataCondition[] conditions,
                                         S7Config s7Config)

Returns a DOM list with search results (from metadata)

Parameters:

folder - - all matched assets will be in this folder

includeSubfolders - - whether to recursively search for assets

assetTypes - - all matched assets will be one of these types

assetSubTypes - array of sub Asset Types to include in search

published - - whether the matched assets must be marked for publish (only marked - not necessarily actually published)

conditions - - metadata conditions for search

s7Config -

Returns:

A list of assets; the list can be empty if no assets have been found.

searchAssetsByMetadata

List<Scene7Asset> searchAssetsByMetadata(String folder,
                                         Boolean includeSubfolders,
                                         String[] assetTypes,
                                         String[] assetSubTypes,
                                         Boolean published,
                                         MetadataCondition[] conditions,
                                         int recordsPerPage,
                                         int resultsPage,
                                         S7Config s7Config)

Returns a DOM list with search results (from metadata), support specify

Parameters:

folder - - all matched assets will be in this folder

includeSubfolders - - whether to recursively search for assets

assetTypes - - all matched assets will be one of these types

assetSubTypes - array of sub Asset Types to include in search

published - - whether the matched assets must be marked for publish (only marked - not necessarily actually published)

conditions - - metadata conditions for search

recordsPerPage - maximum number of results to return

resultsPage - specifies the page of results to return, based on recordsPerPage page size

s7Config -

Returns:

A list of assets; the list can be empty if no assets have been found.

getAssets

List<Scene7Asset> getAssets(String[] assetHandles,
                            String[] responseFields,
                            String[] excludeFields,
                            S7Config s7Config)

Returns a Scene7Asset list, based on a list of asset handles

Parameters:

assetHandles - - the assets to retrieve

responseFields - - fields to be filled in for each node in the tree

excludeFields - - fields to be excluded in each node of the tree

s7Config -

Returns:

A Scene7Asset list

getMultiFileJobLogDetails

ArrayList<UploadJobDetail> getMultiFileJobLogDetails(String jobHandle,
                                                     S7Config s7Config)

Returns an Arraylist of job details objects

Parameters:

jobHandle - - the handle for the job to get details.

s7Config -

Returns:

An AssetList of UploadJobDetail

isJobActiveByJobHandle

boolean isJobActiveByJobHandle(String jobHandle,
                               S7Config s7Config)

Parameters:

jobHandle - of the job

s7Config -

Returns:

true if active job with this jobHandle or orginalName is active, false otherwise

isJobActiveByOriginalName

boolean isJobActiveByOriginalName(String originalName,
                                  S7Config s7Config)

Parameters:

originalName - of the job

s7Config -

Returns:

true if active job with this jobHandle or orginalName is active, false otherwise

getJobLogDetails

List<String> getJobLogDetails(String jobHandle,
                              S7Config s7Config)

Returns a list of Scene7 asset handles(Strings) for the given job handle

Parameters:

jobHandle - - the handle for the job to get details.

s7Config -

Returns:

A list containing asset handles strings

getImagePresets

List<String> getImagePresets(S7Config s7Config)

Returns a list of Scene7 image preset names for the given S7Config

Parameters:

s7Config -

Returns:

a list containing the names of the image presets defined in SPS

getFlashTemplatesServer

String getFlashTemplatesServer(S7Config s7Config)

Retrieves the server used for serving and manipulating flash templates, depending on the Scene7 configuration.

Parameters:

s7Config - the Scene7 configuration

Returns:

a String containing the server's URL

searchAssets

List<Scene7Asset> searchAssets(String folder,
                               Boolean includeSubfolders,
                               Boolean published,
                               String[] assetTypes,
                               String[] assetSubTypes,
                               String[] responseFields,
                               String[] excludeFields,
                               S7Config s7Config)

Retrieves a list of Scene7Assets from the Scene7 server.

Parameters:

folder - the folder from which the assets are retrieved

includeSubfolders - whether to recursively search for assets in sub-folders of the folder where the search is performed

published - whether the matched assets must be marked for publish (only marked - not necessarily actually published)

assetTypes - all matched assets will be one of these types

assetSubTypes - array of sub Asset Types to include in search

responseFields - the response fields that should be used to populate the Scene7Asset's attributes

excludeFields - fields to be excluded from the response

s7Config - the Scene7 configuration

Returns:

a List of assets; can be empty if no assets have been found

searchAssets

List<Scene7Asset> searchAssets(String folder,
                               Boolean includeSubfolders,
                               Boolean published,
                               String[] assetTypes,
                               String[] assetSubTypes,
                               String[] responseFields,
                               String[] excludeFields,
                               int recordsPerPage,
                               int resultsPage,
                               S7Config s7Config)

Retrieves a list of Scene7Assets from the Scene7 server.

Parameters:

folder - the folder from which the assets are retrieved

includeSubfolders - whether to recursively search for assets in sub-folders of the folder where the search is performed

published - whether the matched assets must be marked for publish (only marked - not necessarily actually published)

assetTypes - all matched assets will be one of these types

assetSubTypes - array of sub Asset Types to include in search

responseFields - the response fields that should be used to populate the Scene7Asset's attributes

excludeFields - fields to be excluded from the response

recordsPerPage - maximum number of results to return

resultsPage - specifies the page of results to return, based on recordsPerPage page size

s7Config - the Scene7 configuration

Returns:

a List of assets; can be empty if no assets have been found

searchAssetsByFilename

List<Scene7Asset> searchAssetsByFilename(String folder,
                                         Boolean includeSubfolders,
                                         Boolean published,
                                         String filename,
                                         S7Config s7Config)

Retrieve a list of Scene7Assets from the Scene7 server by filename.

Parameters:

folder -

includeSubfolders -

published -

filename -

s7Config -

Returns:

searchAssetsByName

List<Scene7Asset> searchAssetsByName(String folder,
                                     Boolean includeSubfolders,
                                     Boolean published,
                                     String name,
                                     S7Config s7Config)

Retrieve a list of Scene7Assets from the Scene7 server by Scene7 asset name.

Parameters:

folder -

includeSubfolders -

published -

name -

s7Config -

Returns:

getAssociatedAssets

Scene7Asset getAssociatedAssets(Scene7Asset asset,
                                S7Config s7Config)

Retrieves the sub-assets and the origiator asset associated with the given asset

Parameters:

asset - - the asset to get the sub-assets and generator from

s7Config - - the Scene7 configuration

Returns:

the original Scene7Asset object updated with the sub-assets and the originator asset

getMasterAsset

Scene7Asset getMasterAsset(Scene7Asset asset,
                           S7Config s7Config)

Retrieves the originator asset associated with the given asset

Parameters:

asset - - the asset to get the originator asset

s7Config - - the Scene7 configuration

Returns:

the original Scene7Asset object updated with the originator asset

getFxgServer

String getFxgServer(S7Config s7Config)

Retrieves the server handling FXG rendering.

Parameters:

s7Config - the Scene7 configuration

Returns:

a String containing the FXG server URL

setAssetPublishState

String setAssetPublishState(Resource resource,
                            boolean markForPublish,
                            S7Config s7Config)

Set the publish state of a given Scene7 asset

Parameters:

resource - activated resource

markForPublish - value of markForPublish flag

s7Config - the Scene7 configuration

Returns:

String success / failure

setAssetPublishState

String setAssetPublishState(String assetHandle,
                            boolean markForPublish,
                            S7Config s7Config)

Set the publish state of a given Scene7 asset

Parameters:

assetHandle - unique asset identifier

markForPublish - value of markForPublish flag

s7Config - the Scene7 configuration

Returns:

String success / failure

createFolder

String createFolder(S7Config s7Config,
                    String cqFolderPath)

Create a folder on Scene7 server

Parameters:

s7Config - the Scene7 configuration

cqFolderPath - the path the target cq folder targeted in the s7 folder organization

Returns:

folder handle or null if the folder does not exist in s7.

createImageSet

String createImageSet(S7Config s7Config,
                      String imageSetFolder,
                      String imageSetName,
                      String thumbAssetHandle)

Create an ImageSet asset on Scene7 server

Parameters:

s7Config - the Scene7 configuration

imageSetFolder - the path the target imageset cq folder targeted in the s7 folder organization

imageSetName - name of the image set

thumbAssetHandle - (optional) user defined thumbnail asset handle

Returns:

updateImageSet

void updateImageSet(S7Config s7Config,
                    String imageSetAssetHandle,
                    List<String> setMemberHandles,
                    String thumbAssetHandle)

Update an ImageSet asset on Scene7 server

Parameters:

s7Config - the Scene7 configuration

imageSetAssetHandle - image set Scene7 asset handle

setMemberHandles - asset handles of image set members

thumbAssetHandle - (optional) user defined thumbnail asset handle

createViewerPreset

String createViewerPreset(S7Config s7Config,
                          String folderHandle,
                          String name,
                          String type,
                          List<Scene7ConfigSetting> configSettings)

Create a preset view to determine what users can see. The preset view is applied when assets are published.

Parameters:

s7Config - the Scene7 configuration

folderHandle - folder handle of the folder that contains the assets

name - name for the viewer

type - type of any available viewer in IPS

configSettings - list containing Scene7ConfigSetting values to apply

Returns:

viewer preset handle or null if unsuccessful

getViewerConfigSettings

Scene7ViewerConfig getViewerConfigSettings(S7Config s7Config,
                                           String assetHandle)

Get the viewer configuration for the referenced asset

Parameters:

s7Config - the Scene7 configuration

assetHandle - asset handle for the asset of interest

Returns:

Scene7ViewerConfig with the information or null if unsuccessful

setViewerConfigSettings

void setViewerConfigSettings(S7Config s7Config,
                             String assetHandle,
                             String name,
                             String type,
                             List<Scene7ConfigSetting> configSettings)

Attach viewer configuration settings to an asset Can be viewer preset or the source asset for the viewer

Parameters:

s7Config - the Scene7 configuration

assetHandle - asset handle for the asset to modify

name - name of the asset

type - type of any available viewer in IPS

configSettings - list containing Scene7ConfigSetting values to apply

updateViewerConfigSettings

void updateViewerConfigSettings(S7Config s7Config,
                                String assetHandle,
                                List<Scene7ConfigSetting> configSettings)

Updates SWF viewer configuration settings.

Parameters:

s7Config - the Scene7 configuration

assetHandle - asset handle for the asset to modify

configSettings - list containing Scene7ConfigSetting values to apply

addUser

String addUser(S7Config s7Config,
               String firstName,
               String lastName,
               String email,
               String defaultRole,
               String password,
               org.joda.time.Instant passwordExpires,
               boolean isValid,
               List<Scene7CompanyMembership> membershipArray)

Creates a user account and adds the account to one of more companies

Parameters:

s7Config - The Scene7 configuration

firstName - The user's first name

lastName - The user's last name

email - The user's email address

defaultRole - The role for the user in the companies they belong, the IpsAdmin role overrides other per-company settings

password - The user's password

passwordExpires - The instant of expiration of the password

isValid - Determine the user's validity

membershipArray - List of Scene7CompanyMembership entries enumerating the membership of the user.

Returns:

The handle of the newly created user

getAllUsers

List<Scene7User> getAllUsers(S7Config s7Config,
                             boolean includeInvalid)

Return all users

Parameters:

s7Config - The Scene7 configuration

includeInvalid - Indicate if invalid users should be included

Returns:

List containing Scene7User requested

getUsers

List<Scene7User> getUsers(S7Config s7Config,
                          Boolean includeInactive,
                          Boolean includeInvalid,
                          List<String> companyHandleArray,
                          List<String> groupHandleArray,
                          List<String> userRoleArray,
                          String charFilterField,
                          String charFilter,
                          String sortBy,
                          Integer recordsPerPage,
                          Integer resultsPage)

Return a optionally sorted, filtered and paged list user results

Parameters:

s7Config - The Scene7 config

includeInactive - Include or exclude inactive members

includeInvalid - Include or exclude invalid members

companyHandleArray - Filter results be company

groupHandleArray - Filter results by group

userRoleArray - Filter results by user role

charFilterField - Filter results by field's string prefix

charFilter - Filter results by a specific character

sortBy - Choice of user sort field

recordsPerPage - Number of records per page to return

resultsPage - The desired result page

Returns:

List containing Scene7User requested

setUserInfo

void setUserInfo(S7Config s7Config,
                 String userHandle,
                 String firstName,
                 String lastName,
                 String email,
                 String defaultRole,
                 org.joda.time.Instant passwordExpires,
                 boolean isValid,
                 List<Scene7CompanyMembership> membershipArray)

Set user attributes

Parameters:

s7Config - The Scene7 config

userHandle - User handle

firstName - First name

lastName - Last name

email - Email address

defaultRole - The role for the user in the companies they belong, the IpsAdmin role overrides other per-company settings

passwordExpires - The password's expiration

isValid - Determine if valid IPS user

membershipArray - List of Scene7CompanyMembership entries enumerating the membership of the user

deleteImageFormat

void deleteImageFormat(S7Config s7Config,
                       String imageFormatHandle)

Deletes an image format.

Parameters:

s7Config - The Scene7 config

imageFormatHandle - Handle to the image format. (This is returned from saveImageFormat(S7Config, String, String, String))

getImageFormats

List<Scene7ImageFormat> getImageFormats(S7Config s7Config)

Returns image formats, such as PDF, EPS, SWF, and others.

Parameters:

s7Config - The Scene7 config

Returns:

A list of Scene7ImageFormat objects

saveImageFormat

String saveImageFormat(S7Config s7Config,
                       String imageFormatHandle,
                       String name,
                       String urlModifier)

Create an image format.

Parameters:

s7Config - The Scene7 config

imageFormatHandle - Image format handle you want to save

name - Image format name

urlModifier - IPS protocol query string

Returns:

The imageFormatHandle

deleteImageMap

void deleteImageMap(S7Config s7Config,
                    String imageMapHandle)

Deletes an image map

Parameters:

s7Config - The Scene7 config

imageMapHandle - Handle for the image map to delete

saveImageMap

String saveImageMap(S7Config s7Config,
                    String assetHandle,
                    String imageMapHandle,
                    String name,
                    String shapeType,
                    String region,
                    String action,
                    int position,
                    boolean enabled)

Create a new image map or edit an existing map

Parameters:

s7Config - The Scene7 config

assetHandle - Handle to the asset the map belongs to

imageMapHandle - Handle to the image map.

name - Name of the image map

shapeType - Choice of region shape

region - A comma delimited list of points that define the region

action - The href value associated with the image map

position - The order in the list of image maps

enabled - Whether this map is enabled

Returns:

The handle to the new or edited image map

setImageMaps

List<String> setImageMaps(S7Config s7Config,
                          String assetHandle,
                          List<Scene7ImageMapDefinition> imageMap)

Sets the image map for an asset. You must have already created the image maps. Image maps are applied in order of retrieval from the array. This means the second image map overlays the first, the third overlays the second, and so on.

Parameters:

s7Config - The Scene7 config

assetHandle - Handle to the asset

imageMap - list of predefined Scene7ImageMapDefinition objects

Returns:

list of image map handles applied to the asset