| Package | Description |
|---|---|
| com.fatwire.services | |
| com.fatwire.services.authorization |
| Modifier and Type | Method and Description |
|---|---|
int |
SearchService.addBookmarks(List<AssetId> assets)
Bookmarks the specified assets.
|
boolean |
SiteService.addUserPreference(String userid,
String siteid,
String name,
String value)
Adds or updates user preferences for the logged in user
|
void |
ApprovalService.approve(long destinationId,
List<AssetId> assetsToApprove,
boolean recursive)
Attempts to approve a list of assets for a specified destination.
|
PermissionBean<Object> |
AuthorizationService.canAccessSlot(AssetId slot,
String function)
Checks whether logged in user has access to the specified slot asset in the logged in site.
|
PermissionBean<VersioningAuthorizationBean> |
AuthorizationService.canApprove(AssetId assetId)
Checks whether logged in user has access to approve the asset for the
logged-in site
|
PermissionBean<VersioningAuthorizationBean> |
AuthorizationService.canCheckin(AssetId assetId)
Checks whether logged-in user has access to checking the assets for the
logged-in site
|
PermissionBean<VersioningAuthorizationBean> |
AuthorizationService.canCheckout(AssetId assetId)
Checks whether logged-in user has access to checkout the asset for the
logged-in site
|
PermissionBean<Object> |
AuthorizationService.canCopy(AssetId assetId)
Checks whether logged in user has access to copy the asset for the
logged-in site
|
PermissionBean<DeleteAuthorizationBean> |
AuthorizationService.canDelete(AssetId assetId)
Checks whether logged-in user has access to delete the asset for the
logged-in site
|
PermissionBean<VersioningAuthorizationBean> |
AuthorizationService.canEdit(AssetId assetId)
Checks whether user have access to edit the assets for the given site
|
PermissionBean<Object> |
AuthorizationService.canInspect(AssetId assetId)
Checks whether logged-in user has access to inspect the asset for the
logged-in site
|
PermissionBean<Object> |
AuthorizationService.canPlacePage(AssetId assetId)
Checks whether logged in user is able to place the page asset for the
logged-in site
|
boolean |
SiteService.canPlacePage(long siteId)
Checks if the logged in user is able to place pages in the specified site.
|
PermissionBean<Object> |
AuthorizationService.canPreview(AssetId assetId)
Checks whether logged-in user has access to preview the assets for the
logged-in site
|
PermissionBean<Object> |
AuthorizationService.canRollback(AssetId assetId)
Checks whether logged-in user has access to roll back the asset for the
logged-in site
|
PermissionBean<VersioningAuthorizationBean> |
AuthorizationService.canShare(AssetId assetId)
Checks whether logged-in user has access to share the assets for the
logged-in site
|
PermissionBean<Object> |
AuthorizationService.canShowVersion(AssetId assetId)
Checks whether logged-in user has access to delete the asset for the
logged-in site
|
PermissionBean<Object> |
AuthorizationService.canTranslate(AssetId assetId)
Checks whether logged-in user has access to translate the asset for the
logged-in site
|
PermissionBean<VersioningAuthorizationBean> |
AuthorizationService.canUndoCheckout(AssetId assetId)
Checks whether the logged-in user has access to undo checkout of the specified asset for
the logged-in site
|
VersionBean |
VersioningService.checkin(AssetId assetId,
String comment,
boolean keepCheckedOut,
MessageCollectors.VersioningMessageCollector collector)
Commits changes to the specified asset and hence creates a new revision for it.
|
VersionBean |
VersioningService.checkout(AssetId assetId,
MessageCollectors.VersioningMessageCollector collector)
Checks out an asset for the logged in user and returns the current revision.
|
AssetSaveStatusBean |
AssetService.copy(AssetId source,
String targetName,
MessageCollectors.SaveAssetsMessageCollector collector)
Copies an asset and returns a new asset with the specified name by
copying fields from the source asset and mutating field values as
governed by the dimension object.
|
boolean |
AssetService.delete(AssetId assetId,
MessageCollectors.DeleteAssetsMessageCollector collector)
Deletes an asset.
|
List<AssetId> |
AssetService.delete(List<AssetId> assetIds,
MessageCollectors.DeleteAssetsMessageCollector collector)
Deletes a list of assets identified by the asset identifiers in
assetsToDelete.
|
boolean |
SearchService.deleteSmartList(long smartListId)
Deletes a smart list.
|
boolean |
AssetService.exists(AssetId assetId)
Returns true if an asset exists.
|
boolean |
AssetService.existsInSite(AssetId assetId,
long siteId)
Returns true if an asset exists in the given site.
|
TemplatesBean |
TemplateService.fetchTemplates(Long site,
TypeBean type,
List<TemplateBean.Type> templateType,
String nameRegex,
Integer start,
Integer pageSize)
Fetches the templates in the specified editorial site as per specified
filter criteria and returns paged results.
|
TemplatesBean |
TemplateService.fetchTemplates(Long site,
TypeBean type,
List<TemplateBean.Type> templateType,
String nameRegex,
Integer start,
Integer pageSize,
String deviceGroupSuffix)
Fetches the templates in the specified editorial site as per specified
filter criteria and returns paged results.
|
List<RoleBean> |
SiteService.getAllRoles()
Returns a list of all roles in the system.
|
List<ArgumentBean> |
TemplateService.getArguments(AssetId assetId)
Returns a list containing the arguments associated with a template for
the specified asset type.
|
List<AssignmentBean> |
WorkflowService.getAssignments()
Returns a list containing the assignments for the specified user.
|
List<AssetId> |
ApprovalService.getBlockingAssets(long destinationId,
AssetId assetId)
Returns a flat list of blocking assets.
|
List<BookmarkBean> |
SearchService.getBookmarks()
Returns the list of bookmarks for the logged in user in the logged in site.
|
List<AssetId> |
VersioningService.getCheckedoutAssets()
Returns the list of assets checked out by the logged in user.
|
List<TreeNodeBean> |
TreeService.getChildren(String loadUrl)
Gets All of the immediate children of a node represented by its LoadURL.
|
List<TreeNodeBean> |
TreeService.getChildren(String loadUrl,
int start)
Gets All of the immediate children of a node from start represented by its LoadURL.
|
List<SiteBean> |
AssetService.getCommonEnabledSites(List<AssetId> assetIds)
Returns the list of sites in which intersection of all the assets enabled sites.
|
List<SiteBean> |
AssetService.getCommonSharedSites(List<AssetId> assetIds)
Returns the list of sites in which intersection of all the assets shared sites.
|
VersionBean |
VersioningService.getCurrentRevision(AssetId assetId)
Returns metadata for the current revision for the specified asset.
|
String |
SiteService.getDefaultWebroot(long siteId)
Return the default webroot defined for the specified site.
|
AssetTypeDef |
AssetService.getDefinition(String type,
String subType)
Returns the asset type definition object for a specified asset type.
|
DestinationBean |
ApprovalService.getDestination(long destinationId)
Returns complete information associated with a publishing destination for
the specified site.
|
List<DestinationBean> |
ApprovalService.getDestinations(long siteId)
Returns a list containing the publishing destinations for the specified
site.
|
List<DestinationBean> |
ApprovalService.getDestinations(long siteId,
DestinationBean.Type destinationType)
Returns a list containing the publishing destinations for the specified site.
|
List<String> |
SiteService.getEnabledTypes(long siteId)
Returns the list of asset types enabled in the specified site.
|
List<AssetId> |
TreeService.getImmediateChildren(String browseUrl)
Gets All of the immediate children of a node represented by its LoadURL.
|
Date |
ApprovalService.getLastPublishDate(long destinationId,
AssetId assetId)
Retrieves the date when an asset has been last published to a specified destination.
|
List<String> |
SiteService.getLocales(long siteId)
Get available Locales for a given site.
|
List<AssetId> |
AssetService.getReferences(AssetId assetId)
Returns a list of asset identifiers for all assets which reference a
given asset.
|
List<TreeNodeBean> |
TreeService.getRoots(List<String> tabs)
Builds a list of tree nodes representing tree tabs.
|
List<AttributeDef> |
SearchService.getSearchEnabledAttributes(String type,
String subType)
Returns a list of
AttributeDef objects for the attributes on which search has been enabled. |
List<SiteBean> |
AssetService.getSitesInWhichEnabled(String assetType)
Returns the list of sites for which the given asset type is enabled.
|
List<SiteBean> |
AssetService.getSitesInWhichShared(AssetId assetId)
Returns the list of sites in which an asset is shared.
|
List<UserBean> |
SiteService.getSiteUsers(long siteId)
Returns the list of those users who have access to the specified site through one or more roles.
|
SmartList |
SearchService.getSmartList(long smartListId)
Returns the smart list with the specified id.
|
List<SmartList> |
SearchService.getSmartLists()
Returns all smart lists for the logged in user in the logged in site.
|
List<StartMenuBean> |
SiteService.getStartMenus(List<StartMenuBean.Type> itemTypes,
List<String> assetTypes,
long siteId)
Returns the list of start menu items for specific asset types for the specified user in the specified site.
|
List<StartMenuBean> |
SiteService.getStartMenus(List<StartMenuBean.Type> types,
long siteId)
Returns the list of start menu items for the specified user in the specified site.
|
ApprovalBean |
ApprovalService.getState(long destinationId,
AssetId assetId)
Returns the approval state of an asset for a given target.
|
List<String> |
AssetService.getSubtypes(String assetType,
Long site)
Returns the List of subtypes for the given flex asset type and site.
|
List<ArgumentBean> |
TemplateService.getTemplateArguments(String templateName,
String assetType)
Returns a list containing the arguments associated with a template for
the specified asset type.
|
List<TemplateBean> |
TemplateService.getTemplates(Long site,
TypeBean type,
List<TemplateBean.Type> templateType,
String nameRegex)
Returns the templates in the specified editorial site as per specified
filter criteria.
|
Map<String,String> |
TreeService.getTreeSections(String tabID)
Gets the sections for the given tab id (not fw_uid)
|
Map<String,String> |
TreeService.getTreeTabs()
Returns the tabs available to the specified user in the specified site.
|
String |
SiteService.getUserPreference(String userid,
String siteid,
String name)
fetch user preference value for login user in specific site
|
Map<String,String> |
SiteService.getUserPreferences(String userid,
String siteid)
retrieve user preferences for login user
in the specified site.
|
List<RoleBean> |
SiteService.getUserRoles(long siteId)
Returns a list of all roles for the logged in user in the specified site.
|
WorkflowBean |
WorkflowService.getWorkflow(long processId)
Returns the workflow for the specified process identifier.
|
PermissionBean<Object> |
AuthorizationService.hasAccess(AssetId assetId,
String function)
Checks whether logged in user can perform the given function the asset
for the logged in site
|
boolean |
SiteService.isPreviewEnabled(long siteId)
Checks whether preview is enabled for assets in the specified site.
|
boolean |
SearchService.isSearchEnabled(String assetType)
Returns true if search is enabled for the specified asset type.
|
boolean |
VersioningService.isTracked(String assetType)
Checks if revision tracking is enabled for the specified asset type.
|
AssetData |
AssetService.newAsset(String type,
String subtype,
StartMenuBean startMenu)
Returns an empty asset data instance for a given asset type.
|
boolean |
SiteService.placePagesSPN(SitePlanNodeBean child,
SitePlanNodeBean target,
List<AssetId> children,
SitePlanNodeBean previous)
Places a Page asset under the specified parent Page asset at the
specified index.
|
AssetData |
AssetService.read(AssetId assetId)
Returns data associated with asset.
|
AssetData |
AssetService.read(AssetId assetId,
List<String> fields)
Returns a subset of the data associated with asset, retrieving only a
subset of the available fields.
|
List<AssetData> |
AssetService.read(List<AssetId> assetIds)
Returns data associated with asset.
|
boolean |
SearchService.removeBookmarks(List<AssetId> bookmarks)
Removes the bookmark for the specified assets, if any.
|
List<AssetId> |
AssetService.removeReferences(AssetId assetId,
List<AssetId> references,
MessageCollectors.RemoveReferenceMessageCollector collector)
Removes the references of an asset.
|
boolean |
SiteService.removeUserPreference(String userid,
String siteid,
String name)
add / update user preferences for login user
|
AssetSaveStatusBean |
AssetService.save(AssetData assetData,
MessageCollectors.SaveAssetsMessageCollector collector)
Saves the data associated with an asset.
|
boolean |
SearchService.saveSmartList(SmartList smartList,
MessageCollectors.SmartListMessageCollector collector)
Saves the specified smart list.
|
List<ResultRow> |
SearchService.search(long siteId,
String phrase,
String phraseOperation,
List<TypeBean> assetTypes,
String searchfield,
int maxResults,
List<SortOrder> sortby)
Returns search results for the specified search parameters.
|
List<ResultRow> |
SearchService.search(SearchCriteria searchCriteria,
int maxResults,
List<SortOrder> sortby)
Returns search results for the specified search criteria.
|
Boolean |
AssetService.share(AssetId assetId,
List<Long> sites)
Shares an asset with all the sites in the specified list.
|
boolean |
WorkflowService.startWorkFlow(AssetId assetId,
Long startmenuId,
WorkflowBean workflow,
String comment,
Map<RoleBean,List<UserBean>> roleUserMapping)
Sets the specified asset assignment into the specified workflow.
|
void |
SiteService.touchAllParentsNode(Long childNodeId) |
AssetSaveStatusBean |
AssetService.translate(AssetId assetid,
String targetName,
DimensionBean dimension,
MessageCollectors.SaveAssetsMessageCollector collector)
Translates an asset and returns a new asset as governed by the specified
dimension object.
|
void |
ApprovalService.unapprove(long destinationId,
AssetId assetId)
Revokes approval of an already approved asset in the life-cycle.
|
void |
ApprovalService.unapprove(long destinationId,
List<AssetId> assetId)
Revokes approval of an already approved asset in the life-cycle.
|
VersionBean |
VersioningService.undoCheckout(AssetId assetId,
MessageCollectors.VersioningMessageCollector collector)
Reverts the changes made to the specified checked-out asset,
and reverts its state back to what it was before being checked out.
|
Boolean |
SiteService.unPlacePagesSPN(SitePlanNodeBean child,
SitePlanNodeBean previous,
SitePlanNodeBean target,
List<AssetId> children)
Unplaces placed pages from a parent.
|
| Modifier and Type | Method and Description |
|---|---|
PermissionBean<T> |
AuthorizationHandler.getPermission(AuthorizationRequestBean request)
Decides if a user is authorized to perform the operation on an asset in a
site.
|