Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
/*************************************************************************
*
* ADOBE CONFIDENTIAL
* ___________________
*
* Copyright 2012 Adobe Systems Incorporated
* All Rights Reserved.
*
* NOTICE: All information contained herein is, and remains
* the property of Adobe Systems Incorporated and its suppliers,
* if any. The intellectual and technical concepts contained
* herein are proprietary to Adobe Systems Incorporated and its
* suppliers and are protected by trade secret or copyright law.
* Dissemination of this information or reproduction of this material
* is strictly forbidden unless prior written permission is obtained
* from Adobe Systems Incorporated.
**************************************************************************/
package com.day.cq.dam.scene7.api;
import java.io.InputStream;
import java.util.List;
import java.util.Map;
import java.util.Set;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import javax.annotation.ParametersAreNonnullByDefault;
import org.apache.sling.api.resource.ResourceResolver;
import org.joda.time.Instant;
import org.w3c.dom.Document;
import aQute.bnd.annotation.ProviderType;
import com.day.cq.dam.scene7.api.constants.Scene7JobType;
import com.day.cq.dam.scene7.api.model.IpsApiException;
import com.day.cq.dam.scene7.api.model.Scene7Asset;
import com.day.cq.dam.scene7.api.model.Scene7CompanyMembership;
import com.day.cq.dam.scene7.api.model.Scene7ConfigSetting;
import com.day.cq.dam.scene7.api.model.Scene7ImageFieldUpdate;
import com.day.cq.dam.scene7.api.model.Scene7ImageMapDefinition;
import com.day.cq.dam.scene7.api.model.Scene7MetadataUpdate;
import com.day.cq.dam.scene7.impl.MetadataCondition;
import com.scene7.ipsapi.ImageSetMemberUpdateArray;
import com.scene7.ipsapi.SmartCropUpdateArray;
import com.scene7.ipsapi.ThumbAssetUpdate;
/**
* The Scene7APIClient provides the Scene7 SPS API methods used by CQ DAM. For more details about the methods please consult the SPS API.
*/
@ProviderType
public interface Scene7APIClient {
/**
* default content-type (i.e. 'application/soap+xml'), defaults to 'text/xml'
*/
static final String CONTENTTYPE = "text/xml";
static final int RECORDS_PER_PAGE_NO_FILTER = 1000;
static final int RECORDS_PER_PAGE_WITH_FILTER = 10000;
/**
* Deletes an asset from Scene7.
*
* @param assetHandle
* the handle to the asset to delete
* @param s7Config
* the Scene7 configuration
* @return the API's response wrapped in a {@link Document}
* @throws IpsApiException
*/
Document deleteAsset(String assetHandle, S7Config s7Config)
throws IpsApiException;
/**
* Delete multiple assets from Scene7.
*
* @param assetHandleArr
* the handle to the asset to delete
* @param s7Config
* the Scene7 configuration
* @return the API's response wrapped in a {@link Document}
* @throws IpsApiException
*/
Document deleteAssets(String[] assetHandleArr, S7Config s7Config)
throws IpsApiException;
/**
* Deletes a folder from Scene7.
*
* @param folderHandle
* the handle to the folder to delete
* @param s7Config
* the Scene7 configuration
* @return the API's response wrapped in a {@link Document}
* @throws IpsApiException
*/
Document deleteFolder(String folderHandle, S7Config s7Config)
throws IpsApiException;
/**
* Gets all jobs that are currently active in the system.
*
* @param jobHandle
* the handle to the job
* @param originalName
* the original name of the job
* @param s7Config
* the Scene7 configuration
* @return the API's response wrapped in a {@link Document}
* @throws IpsApiException
*/
Document getActiveJobs(String jobHandle, String originalName,
S7Config s7Config) throws IpsApiException;
/**
* Gets assets from IPS.
*
* @param assetHandles
* the asset handles
* @param responseFields
* a list of fields and subfields for inclusion in the response
* @param excludeFields
* a list of fields and subfields for exclusion from the response
* @param s7Config
* the Scene7 configuration
* @return the API's response wrapped in a {@link Document}
* @throws IpsApiException
*/
Document getAssets(String[] assetHandles, String[] responseFields,
String[] excludeFields, S7Config s7Config) throws IpsApiException;
/**
* Gets assets associated with the specified asset and details about their
* relationship.
*
* @param assetHandle
* the handle to the asset
* @param responseFields
* a list of fields and subfields for inclusion in the response
* @param excludeFields
* a list of fields and subfields for exclusion from the response
* @param s7Config
* the Scene7 configuration
* @return the API's response wrapped in a {@link Document}
* @throws IpsApiException
*/
Document getAssociatedAssets(String assetHandle, String[] responseFields,
String[] excludeFields, S7Config s7Config) throws IpsApiException;
/**
* Gets a user's memberships.
*
* @param resourceResolver
* resource resolver used to access Scene7 configuration
* @param userHandle
* the handle to the user whose memberships you want to obtain
* @param email
* the user's email
* @param password
* the user's password
* @param region
* the user's region
* @return the API's response wrapped in a {@link Document}
* @throws IpsApiException
*/
Document getCompanyMembership(ResourceResolver resourceResolver,
String userHandle, String email, String password, String region)
throws IpsApiException;
/**
* Gets folders and sub-folders in a hierarchical tree structure. The
* getFolderTree response is limited to a maximum of 100000 folders.
*
* @param folderPath
* the root folder to retrieve folders and all subfolders to the
* leaflevel; if excluded, the company root is used
* @param depth
* a value of zero gets the top-level folder; any other value
* specifies the depth to descend into the tree
* @param responseFields
* a list of fields and subfields for inclusion in the response
* @param excludeFields
* a list of fields and subfields for exclusion from the response
* @param s7Config
* the Scene7 configuration
* @return the API's response wrapped in a {@link Document}
* @throws IpsApiException
*/
Document getFolderTree(String folderPath, int depth,
String[] responseFields, String[] excludeFields, S7Config s7Config)
throws IpsApiException;
/**
* Gets the details of job logs of a company.
*
* @param jobHandle
* a handle to an active or completed job
* @param originalName
* the original name of the job log
* @param s7Config
* the Scene7 configuration
* @return the API's response wrapped in a {@link Document}
* @throws IpsApiException
*/
Document getJobLogDetails(String jobHandle, String originalName,
S7Config s7Config) throws IpsApiException;
/**
* Gets the details of job logs of a company with specified parameters
*
* @param jobHandle
* a handle to an active or completed job
* @param originalName
* the original name of the job log
* @param resultsPage
* page number of recordsPerPage-results to return
* @param recordsPerPage
* maximum number of detailArray items to return
* @param sortBy
* one of the Job Detail Sort Field constant values (Date or
* LogType)
* @param sortDirection
* one of the Sort Direction string constants
* @param s7Config
* the Scene7 configuration
* @return the jobLogDetails API's response wrapped in a {@link Document}
* @throws IpsApiException
*/
Document getJobLogDetails(String jobHandle, String originalName,
int resultsPage, int recordsPerPage, String sortBy,
String sortDirection, S7Config s7Config) throws IpsApiException;
/**
* Gets property sets associated with a type handle.
*
* @param appSettingsTypeHandle
* the handle to the property set type
* @param s7Config
* the Scene7 configuration
* @return the API's response wrapped in a {@link Document}
* @throws IpsApiException
*/
Document getPropertySets(String appSettingsTypeHandle, S7Config s7Config)
throws IpsApiException;
/**
* Gets the property set types associated with the specified company from
* the {@code S7Config} object.
*
* @param s7Config
* the Scene7 configuration
* @return the API's response wrapped in a {@link Document}
* @throws IpsApiException
*/
Document getPropertySetTypes(S7Config s7Config) throws IpsApiException;
/**
* Gets the SPS image presets
*
* @param s7Config
* the Scene7 configuration
* @return the API's response wrapped in a {@link Document}
* @throws IpsApiException
*/
Document getImagePresets(S7Config s7Config) throws IpsApiException;
/**
* Gets information about a user.
*
* @param resourceResolver
* resource resolver used to access Scene7 configuration
* @param email
* the user's email
* @param password
* the user's password
* @param region
* the user's region
* @return the API's response wrapped in a {@link Document}
* @throws IpsApiException
*/
Document getUserInfo(ResourceResolver resourceResolver, String email,
String password, String region) throws IpsApiException;
/**
* Searches for assets based on one or more filter criteria.
*
* @param folder
* the root path for searching for assets; if omitted, the
* company root folder will be used
* @param includeSubfolders
* if true, the search includes sub-folders
* @param published
* if true, the search will include only published assets
* @param assetTypes
* array of Asset Types to include in search
* @param assetSubTypes
* array of sub Asset Types to include in search
* @param responseFields
* a list of fields and subfields for inclusion in the response
* @param excludeFields
* a list of fields and subfields for exclusion from the response
* @param recordsPerPage
* maximum number of results to return
* @param resultsPage
* specifies the page of results to return, based on
* {@code recordsPerPage} page size
* @param fileName
* the filename for search asset
* @param name
* the Scene7 name used for search asset
* @param s7Config
* the Scene7 configuration
* @return the API's response wrapped in a {@link Document}
* @throws IpsApiException
*/
Document searchAssets(String folder, Boolean includeSubfolders, Boolean published, String[] assetTypes, String[] assetSubTypes,
String[] responseFields, String[] excludeFields,
int recordsPerPage, int resultsPage, String fileName, String name,
S7Config s7Config) throws IpsApiException;
/**
* Searches for assets based on one or more filter criteria.
*
* @param folder
* the root path for searching for assets; if omitted, the
* company root folder will be used
* @param includeSubfolders
* if true, the search includes sub-folders
* @param published
* if true, the search will include only published assets
* @param assetTypes
* array of Asset Types to include in search
* @param assetSubTypes
* array of sub Asset Types to include in search
* @param responseFields
* a list of fields and subfields for inclusion in the response
* @param excludeFields
* a list of fields and subfields for exclusion from the response
* @param recordsPerPage
* maximum number of results to return
* @param resultsPage
* specifies the page of results to return, based on
* {@code recordsPerPage} page size
* @param fileName
* the filename for search asset
* @param name
* the Scene7 name used for search asset
* @param conditionMode
* filename and asset name string comparison operator
* @param s7Config
* the Scene7 configuration
* @return the API's response wrapped in a {@link Document}
* @throws IpsApiException
*/
Document searchAssets(String folder, Boolean includeSubfolders,
Boolean published, String[] assetTypes, String[] assetSubTypes,
String[] responseFields, String[] excludeFields,
int recordsPerPage, int resultsPage, String fileName, String name,
String conditionMode, S7Config s7Config) throws IpsApiException;
/**
* Searches the metadata index repository for the given search terms.
*
* @param folder
* the root path for searching for assets; if omitted, the
* company root folder will be used
* @param includeSubfolders
* if true, the search includes sub-folders
* @param assetTypes
* array of Asset Types to include in search
* @param assetSubTypes
* array of sub Asset Types to include in search
* @param published
* if true, the search will include only published assets
* @param conditions
* one or more query conditions that define the search criteria
* @param s7Config
* the Scene7 configuration
* @return the API's response wrapped in a {@link Document}
* @throws IpsApiException
*/
Document searchAssetsByMetadata(String folder, Boolean includeSubfolders, String[] assetTypes, String[] assetSubTypes,
Boolean published,
MetadataCondition[] conditions, S7Config s7Config)
throws IpsApiException;
/**
* Searches the metadata index repository for the given search terms,
* support loading assets by page
*
* @param folder
* the root path for searching for assets; if omitted, the
* company root folder will be used
* @param includeSubfolders
* if true, the search includes sub-folders
* @param assetTypes
* array of Asset Types to include in search
* @param assetSubTypes
* array of sub Asset Types to include in search
* @param published
* if true, the search will include only published assets
* @param conditions
* one or more query conditions that define the search criteria
* @param recordsPerPage
* maximum number of results to return
* @param resultsPage
* specifies the page of results to return, based on
* {@code recordsPerPage} page size
* @param s7Config
* the Scene7 configuration
* @return the API's response wrapped in a {@link Document}
* @throws IpsApiException
*/
Document searchAssetsByMetadata(String folder, Boolean includeSubfolders, String[] assetTypes,
String[] assetSubTypes, Boolean published, MetadataCondition[] conditions, int recordsPerPage,
int resultsPage, S7Config s7Config) throws IpsApiException;
/**
* Submits a job to the system.
*
* @param jobName
* the name of the job
* @param jobType
* the job's type
* @param s7Config
* the Scene7 configuration
* @return the API's response wrapped in a {@link Document}
* @throws IpsApiException
* @see Scene7JobType
*/
Document submitJob(String jobName, Scene7JobType jobType, S7Config s7Config)
throws IpsApiException;
/**
* Retrieves the system properties XML document served by the GetSystemProperties SPS servlet.
* Deprecated
*
* @param s7Config the Scene7 configuration
* @return the SPS system properties wrapped in a {@link Document}
*/
@Deprecated
Document getSystemProperties(S7Config s7Config);
/**
* Provides a way to get the originally uploaded file to the Scene7 servers
* after an asset has been processed.
*
* @param assetHandle
* the asset's handle (unique id generated by Scene7)
* @param s7Config
* the Scene7 configuration
* @return an InputStream from which the file can be retrieved; the
* InputStream can be null if any error occurred
* @throws IpsApiException
*/
InputStream getOriginalFile(String assetHandle, S7Config s7Config)
throws IpsApiException;
/**
* Provides a way to get the published image for a Scene7 asset
*
* @deprecated Incompatible with Scene7 IPS SSL endpoint. Please use
* getOriginalFile() instead.
*
* @param asset
* the Scene7Asset asset object
* @param s7Config
* the S7Config configuration
* @return an InputStream of the published image asset
*/
@Deprecated
InputStream getIPSFile(Scene7Asset asset, S7Config s7Config);
/**
* Retrieves a JPEG image in an InputStream that can be used as a thumbnail
* in CQ DAM. The image has the same size as the originally uploaded asset
* from Scene7.
*
* @param scene7Asset
* the Scene7 asset abstractization
* @param s7Config
* the Scene7 configuration
* @return an InputStream from which the file can be retrieved; the
* InputStream can be null if any error occurred
* @throws IpsApiException
*/
InputStream getThumbnailForAsset(Scene7Asset scene7Asset, S7Config s7Config)
throws IpsApiException;
/**
* Sets the publish state of a given Scene7 asset
*
* @param assetHandle
* the Scene7 asset handle
* @param publishState
* the asset publish state
* @param s7Config
* the Scene7 configuration
* @return the setAssetPublishState API's response wrapped in a
* {@link Document}
* @throws IpsApiException
*/
Document setAssetPublishState(String assetHandle, S7Config s7Config,
String publishState) throws IpsApiException;
/**
* Sets the publish state of a given Scene7 assets
*
* @param assetHandles
* the Scene7 asset handles
* @param publishState
* the asset publish state
* @param s7Config
* the Scene7 configuration
* @return the setAssetPublishState API's response wrapped in a
* {@link Document}
* @throws IpsApiException
*/
Document setAssetsPublishState(Set assetHandles, S7Config s7Config,
String publishState) throws IpsApiException;
/**
* Create an ImageSet in a given Scene7 folder
*
* @param s7Config
* the Scene7 configuration
* @param folderHandle
* Scene7 folder handle
* @param name
* name of image set
* @param type
* type of new image set
* @param thumbAssetHandle
* (optional) asset handle of user-defined thumbnail image for
* set
* @return the IPS API response wrapped in a {@link Document}
* @throws IpsApiException
*/
@ParametersAreNonnullByDefault
Document createImageSet(S7Config s7Config, String folderHandle, String name, String type,
@Nullable String thumbAssetHandle)
throws IpsApiException;
/**
* Update an ImageSet
*
* @param s7Config
* the Scene7 configuration
* @param assetHandle
* asset handle of the image set to update
* @param members
* (optional) list of imageset members (Null = not updated)
* @param thumbAssetHandle
* (optional) asset handle of user-defined thumbnail image for
* set (Null = not updated)
* @return the IPS API response wrapped in a {@link Document}
* @throws IpsApiException
*/
@ParametersAreNonnullByDefault
Document updateImageSet(S7Config s7Config, String assetHandle,
@Nullable ImageSetMemberUpdateArray members,
@Nullable String thumbAssetHandle) throws IpsApiException;
/**
* Update an image set of a given a list of Scene7 assets
*
* @param s7Config
* the Scene7 configuration
* @param assetHandle
* asset handle of the image set member array
* @param setMemberHandles
* list of image set member handles
* @param thumbAssetHandle
* optional parameter to define set thumbnail
* @return the updateImageSet API's response wrapped in a {@link Document}
* @deprecated Use {@link #updateImageSet(S7Config, String, ImageSetMemberUpdateArray, String)}
*/
@Deprecated
Document updateImageSet(S7Config s7Config, String assetHandle,
List setMemberHandles, String thumbAssetHandle);
/**
* Create an AssetSet in a given Scene7 folder
*
* @param s7Config
* the Scene7 configuration
* @param folderHandle
* Scene7 folder handle
* @param name
* name for new asset set
* @param type
* type of new asset set
* @param setDefinition
* (optional) set's definition string
* @param thumbAssetHandle
* (optional) asset handle of user-defined thumbnail image for
* set
* @return the IPS API response wrapped in a {@link Document}
* @throws IpsApiException
*/
@ParametersAreNonnullByDefault
Document createAssetSet(S7Config s7Config, String folderHandle, String name, String type,
@Nullable String setDefinition,
@Nullable String thumbAssetHandle) throws IpsApiException;
/**
* Update an AssetSet
*
* @param s7Config
* the Scene7 configuration
* @param assetHandle
* asset handle of the asset set to update
* @param setDefinition
* (optional) set's definition string (Null = not updated)
* @param thumbAssetHandle
* (optional) asset handle of user-defined thumbnail image for
* set (Null = not updated)
* @return the IPS API response wrapped in a {@link Document}
* @throws IpsApiException
*/
@ParametersAreNonnullByDefault
Document updateAssetSet(S7Config s7Config, String assetHandle,
@Nullable String setDefinition, @Nullable String thumbAssetHandle)
throws IpsApiException;
/**
* Create a folder on Scene7 server
*
* @param folderPath
* The root folder used to retrieve folders and all subfolders to
* the leaf level. If excluded, the company root is used.
* @param s7Config
* the Scene7 configuration
* @return the createFolder API response wrapped in a {@link Document}
* @throws IpsApiException
*/
Document createFolder(String folderPath, S7Config s7Config)
throws IpsApiException;
/**
* Create a preset view to determine what users can see.
*
* The preset view is applied when assets are published.
*
* @param s7Config
* the Scene7 configuration
* @param folderHandle
* folder handle of the folder that contains the assets
* @param name
* name for the viewer
* @param type
* type of any available viewer in IPS
* @param configSettings
* list containing {@link Scene7ConfigSetting} values to apply
* @return the createViewerPreset API response wrapped in a {@link Document}
* @throws IpsApiException
*/
@ParametersAreNonnullByDefault
Document createViewerPreset(
S7Config s7Config,
String folderHandle,
String name,
String type,
@Nullable List configSettings)
throws IpsApiException;
/**
* Get all viewer configuration for the specified asset
*
* @param s7Config
* the Scene7 configuration
* @param assetHandle
* asset handle for the asset in question
* @return the getViewerConfigSettings API response wrapped in a
* {@link Document}
* @throws IpsApiException
*/
@ParametersAreNonnullByDefault
Document getViewerConfigSettings(S7Config s7Config, String assetHandle)
throws IpsApiException;
/**
* Attach viewer configuration settings to an asset
*
* Can be viewer preset or the source asset for the viewer
*
* @param s7Config
* the Scene7 configuration
* @param assetHandle
* asset handle for the asset to modify
* @param name
* name of the asset
* @param type
* type of any available viewer in IPS
* @param configSettings
* list containing {@link Scene7ConfigSetting} values to apply
* @throws IpsApiException
*/
@ParametersAreNonnullByDefault
Document setViewerConfigSettings(
S7Config s7Config,
String assetHandle,
String name,
String type,
List configSettings)
throws IpsApiException;
/**
* Updates SWF viewer configuration settings.
*
* @param s7Config
* the Scene7 configuration
* @param assetHandle
* asset handle for the asset to modify
* @param configSettings
* list containing {@link Scene7ConfigSetting} values to apply
* @throws IpsApiException
*/
@ParametersAreNonnullByDefault
Document updateViewerConfigSettings(S7Config s7Config, String assetHandle,
List configSettings) throws IpsApiException;
/**
* Creates a user account and adds the account to one of more companies
*
* @param s7Config
* The Scene7 configuration
* @param firstName
* The user's first name
* @param lastName
* The user's last name
* @param email
* The user's email address
* @param defaultRole
* The role for the user in the companies they belong, the
* IpsAdmin role overrides other per-company settings
* @param password
* The user's password
* @param passwordExpires
* The instant of expiration of the password
* @param isValid
* Determine the user's validity
* @param membershipArray
* List of {@link Scene7CompanyMembership} entries enumerating
* the membership of the user.
* @return
* @throws IpsApiException
*/
@ParametersAreNonnullByDefault
Document addUser(
S7Config s7Config,
String firstName,
String lastName,
String email,
String defaultRole,
String password,
@Nullable Instant passwordExpires,
boolean isValid,
List membershipArray)
throws IpsApiException;
/**
* Return all users
*
* @param s7Config
* The Scene7 configuration
* @param includeInvalid
* Indicate if invalid users should be included
* @return
* @throws IpsApiException
*/
Document getAllUsers(@Nonnull S7Config s7Config, boolean includeInvalid)
throws IpsApiException;
/**
* Return a optionally sorted, filtered and paged list user results
*
* @param s7Config
* The Scene7 config
* @param includeInactive
* Include or exclude inactive members
* @param includeInvalid
* Include or exclude invalid members
* @param companyHandleArray
* Filter results be company
* @param groupHandleArray
* Filter results by group
* @param userRoleArray
* Filter results by user role
* @param charFilterField
* Filter results by field's string prefix
* @param charFilter
* Filter results by a specific character
* @param sortBy
* Choice of user sort field
* @param recordsPerPage
* Number of records per page to return
* @param resultsPage
* The desired result page
* @return
* @throws IpsApiException
*/
Document getUsers(
@Nonnull S7Config s7Config,
@Nullable Boolean includeInactive,
@Nullable Boolean includeInvalid,
@Nullable List companyHandleArray,
@Nullable List groupHandleArray,
@Nullable List userRoleArray,
@Nullable String charFilterField,
@Nullable String charFilter,
@Nullable String sortBy,
@Nullable Integer recordsPerPage,
@Nullable Integer resultsPage) throws IpsApiException;
/**
* Set user attributes
*
* @param s7Config
* The Scene7 config
* @param userHandle
* User handle
* @param firstName
* First name
* @param lastName
* Last name
* @param email
* Email address
* @param defaultRole
* The role for the user in the companies they belong, the
* IpsAdmin role overrides other per-company settings
* @param passwordExpires
* The password's expiration
* @param isValid
* Determine if valid IPS user
* @param membershipArray
* List of {@link Scene7CompanyMembership} entries enumerating
* the membership of the user
* @return
* @throws IpsApiException
*/
@ParametersAreNonnullByDefault
Document setUserInfo(
S7Config s7Config,
@Nullable String userHandle,
String firstName,
String lastName,
String email,
String defaultRole,
@Nullable Instant passwordExpires,
boolean isValid,
List membershipArray)
throws IpsApiException;
/**
* Deletes an image format.
*
* @param s7Config
* The Scene7 config
* @param imageFormatHandle
* Handle to the image format. (This is returned from
* {@link #saveImageFormat(S7Config, String, String, String)})
* @throws IpsApiException
*/
@ParametersAreNonnullByDefault
Document deleteImageFormat(S7Config s7Config, String imageFormatHandle)
throws IpsApiException;
/**
* Returns image formats, such as PDF, EPS, SWF, and others.
*
* @param s7Config
* The Scene7 config
* @return
* @throws IpsApiException
*/
Document getImageFormats(@Nonnull S7Config s7Config) throws IpsApiException;
/**
* Create an image format.
*
* @param s7Config
* The Scene7 config
* @param imageFormatHandle
* Image format handle you want to save
* @param name
* Image format name
* @param urlModifier
* IPS protocol query string
*
* @return
* @throws IpsApiException
*/
@ParametersAreNonnullByDefault
Document saveImageFormat(S7Config s7Config,
@Nullable String imageFormatHandle, String name, String urlModifier)
throws IpsApiException;
/**
* Deletes an image map
*
* @param s7Config
* The Scene7 config
* @param imageMapHandle
* Handle for the image map to delete
* @throws IpsApiException
*/
@ParametersAreNonnullByDefault
Document deleteImageMap(S7Config s7Config, String imageMapHandle)
throws IpsApiException;
/**
* Create a new image map or edit an existing map
*
* @param s7Config
* The Scene7 config
* @param assetHandle
* Handle to the asset the map belongs to
* @param imageMapHandle
* Handle to the image map.
* @param name
* Name of the image map
* @param shapeType
* Choice of region shape
* @param region
* A comma delimited list of points that define the region
* @param action
* The href value associated with the image map
* @param position
* The order in the list of image maps
* @param enabled
* Whether this map is enabled
* @return
* @throws IpsApiException
*/
@ParametersAreNonnullByDefault
Document saveImageMap(
S7Config s7Config,
String assetHandle,
@Nullable String imageMapHandle,
String name,
String shapeType,
String region,
String action,
int position,
boolean enabled)
throws IpsApiException;
/**
* 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.
*
* @param s7Config
* The Scene7 config
* @param assetHandle
* Handle to the asset
* @param imageMap
* list of predefined {@link Scene7ImageMapDefinition} objects
* @return
* @throws IpsApiException
*/
@ParametersAreNonnullByDefault
Document setImageMaps(S7Config s7Config, String assetHandle,
List imageMap) throws IpsApiException;
/**
* Sets asset metadata using batch mode.
*
* @param s7Config
* The Scene7 config
* @param updates
* List of {@link Scene7ImageFieldUpdate} to be applied
* @throws IpsApiException
*/
@ParametersAreNonnullByDefault
Document batchSetAssetMetadata(
S7Config s7Config,
List updates) throws IpsApiException;
/**
* Sets asset metadata using batch mode.
*
* @param s7Config
* The Scene7 config
* @param updates
* List of {@link Scene7ImageFieldUpdate} to be applied
* @throws IpsApiException
*/
@ParametersAreNonnullByDefault
Document batchSetImageFields(
S7Config s7Config,
List updates) throws IpsApiException;
/**
* Retrieves Scene7 upload job processing status
*
* @param jobHandle
* Scene7 upload job handle
* @param s7Config
* Scene7 configuration object
* @return the API's response wrapped in a {@link Document}
* @throws IpsApiException
*/
Document getUploadTaskStatus(String jobHandle, S7Config s7Config)
throws IpsApiException;
/**
* Moves an asset to a specific folder
*
* @param s7Config
* Scene7 configuration object
* @param assetHandle
* Handle to the asset you want to move
* @param folderHandle
* Handle to the destination folder
* @return The API's response wrapped in a {@link Document}
* @throws IpsApiException
*/
Document moveAsset(S7Config s7Config, String assetHandle,
String folderHandle) throws IpsApiException;
/**
* Moves multiple assets independently of each other. It accomplishes this
* using the AssetMove type contained in the assetMoveArray. Each AssetMove
* field contains a destination folder
*
* @param s7Config
* Scene7 configuration object
* @param assetFolderHandles
* Map that contains an asset and an asset destination folder
*
* @return The API's response wrapped in a {@link Document}
* @throws IpsApiException
*/
Document moveAssets(S7Config s7Config,
Map assetFolderHandles) throws IpsApiException;
/**
* Move a folder to a new location
*
* @param s7Config
* Scene7 configuration object
* @param sourceFolderHandle
* Handle to the source folder
* @param destinationFolderHandle
* Handle to the destination folder
* @return The API's response wrapped in a {@link Document}
* @throws IpsApiException
*/
Document moveFolder(S7Config s7Config, String sourceFolderHandle,
String destinationFolderHandle) throws IpsApiException;
/**
* Rename an asset
*
* @param s7Config
* Scene7 configuration object
* @param assetHandle
* Handle to the asset you want to move
* @param name
* Asset's new name
* @param validateName
* If the validateName is true and the asset type requires a
* unique IPS ID, then the new name is checked for global
* uniqueness and renameAsset throws a fault if it is not unique.
* @return The API's response wrapped in a {@link Document}
* @throws IpsApiException
*/
Document renameAsset(S7Config s7Config, String assetHandle, String name,
boolean validateName) throws IpsApiException;
/**
* Rename a folder
*
* @param s7Config
* Scene7 configuration object
* @param folderHandle
* Handle to the folder
* @param folderName
* New folder name
* @return The API's response wrapped in a {@link Document}
* @throws IpsApiException
*/
Document renameFolder(S7Config s7Config, String folderHandle,
String folderName) throws IpsApiException;
/**
* Sets the thumbnail image for one or more assets
*
* @param s7Config
* Scene7 configuration object
* @param thumbnailUpdates
* List of {@link ThumbAssetUpdate} objects to be applied
* @return The API's response wrapped in a {@link Document}
* @throws IpsApiException
* in case of IPS failures or undefined data format
*/
@ParametersAreNonnullByDefault
Document batchSetThumbAsset(S7Config s7Config,
List thumbnailUpdates) throws IpsApiException;
/**
* Update one or more Smart Crop sub asset(s)
*
* @param s7Config
* Scene7 configuration object
* @param updateArray
* Array of SmartCropUpdate objects containing subasset handles
* and NormalizedCropRect values
* @return The API's response wrapped in a {@link Document}
* @throws IpsApiException
*/
Document updateSmartCrops(S7Config s7Config,
SmartCropUpdateArray updateArray) throws IpsApiException;
}
