Package | Description |
---|---|
com.fatwire.assetapi.common | |
com.fatwire.assetapi.data | |
com.fatwire.assetapi.def | |
com.fatwire.assetapi.query | |
com.fatwire.assetapi.site |
Modifier and Type | Class and Description |
---|---|
class |
AssetNotExistException
The Exception class indicates an asset is not found in Content Server
|
Modifier and Type | Method and Description |
---|---|
void |
TagManager.addTag(String tagname, AssetId asset)
Adds a tag to given asset.
|
void |
TagManager.addTag(String category, String tagName, String tagValue, AssetId asset)
Adds a tag to given asset.
|
void |
TagManager.addTag(String type, String tagName, String tagValue, AssetId asset, boolean isAssetSave, boolean isAfterPublish)
Add a tag to the give asset.
|
void |
RevisionTrackingManager.checkIn(List<AssetId> ids)
Checks in a given collection of AssetIds
|
void |
RevisionTrackingManagerImpl.checkIn(List<AssetId> ids) |
void |
RevisionTrackingManager.checkIn(List<AssetId> ids, String checkinMsg)
Checks in a given collection of AssetIds
|
void |
RevisionTrackingManagerImpl.checkIn(List<AssetId> ids, String checkinMsg) |
void |
RevisionTrackingManager.checkOut(List<AssetId> ids)
Checks out a collection of AssetIds
|
void |
RevisionTrackingManagerImpl.checkOut(List<AssetId> ids) |
AssetData |
ABTestAssetManager.createABTest(String testName, String testContext)
Create a new WCS_ABTest asset
|
AssetData |
ABTestAssetManager.createABTest(String testName, String testContext, String copyFromAssetId)
Create a new WCS_ABTest asset from the existing WCS_ABTest asset.
|
MutableAssetData |
AssetDataManagerImpl.deepCopy(AssetData example)
Creates a deep copy of an AssetData object, copying all the data
|
void |
AssetDataManager.delete(List<AssetId> data)
Deletes a given list of AssetIds from database.
|
void |
BasicAssetDataWriteStrategy.delete(List<AssetId> data) |
void |
AssetDataWriteStrategy.delete(List<AssetId> data)
Delete a given list of assts from Content Server
|
void |
AssetDataManagerImpl.delete(List<AssetId> data) |
void |
TagManager.deleteTags(AssetId asset, boolean isAssetSave, boolean isPublish)
Completely delete all tags for given asset
|
void |
TagManager.deleteVoids()
Delete all voided tags
|
List<AssetResultRow> |
ContentQueryManager.execute(long contentQueryId, String siteName)
Given the id of Content Query, this fetches the list of assets matching Content Query's search criteria.
|
List<AssetResultRow> |
ContentQueryManagerImpl.execute(long contentQueryId, String siteName) |
List<AssetResultRow> |
ContentQueryManager.execute(long contentQueryId, String siteName, Integer listSize, String sortField, String sortOrder)
Given the name of Content Query, this fetches the list of assets matching Content Query's search criteria.
|
List<AssetResultRow> |
ContentQueryManagerImpl.execute(long contentQueryId, String siteName, Integer listSize, String sortField, String sortOrder) |
List<AssetResultRow> |
ContentQueryManager.execute(String contentQueryName, String siteName)
Given the name of Content Query, this fetches the list of assets matching Content Query's search criteria.
|
List<AssetResultRow> |
ContentQueryManagerImpl.execute(String contentQueryName, String siteName) |
List<AssetResultRow> |
ContentQueryManager.execute(String contentQueryName, String siteName, Integer listSize, String sortField, String sortOrder)
Given the name of Content Query, this fetches the list of assets matching Content Query's search criteria.
|
List<AssetResultRow> |
ContentQueryManagerImpl.execute(String contentQueryName, String siteName, Integer listSize, String sortField, String sortOrder) |
List<AssetResultRow> |
AssetFacade.executeContentQuery(String siteName, Long assetId, String assetName, int limit, String sortingField, boolean ascending)
Execute a ContentQuery to retrieve the results
|
List<AssetResultRow> |
AssetFacadeImpl.executeContentQuery(String siteName, Long assetId, String assetName, int limit, String sortingField, boolean ascending) |
AssetData |
RevisionTrackingManager.get(AssetId id, int versionNnmber)
Returns AssetData for a given asset and version number.
|
AssetData |
RevisionTrackingManagerImpl.get(AssetId id, int versionNnmber) |
AssetData |
ABTestAssetManager.getABTest(Long testId) |
String |
ABTestAssetManager.getABTestConversion(Long testId) |
List<AssetData> |
ABTestAssetManager.getABTests(long siteid) |
List<AssetData> |
ABTestAssetManager.getABTests(long siteid, String assetType, String assetId) |
List<AssetData> |
ABTestAssetManager.getABTests(long siteid, String assetType, String assetId, String pageName) |
List<String> |
ABTestAssetManager.getABTestVariants(Long testId) |
Iterable<AssetData> |
ABTestAssetManager.getActiveTests() |
List<AssetData> |
RevisionTrackingManager.getAll(AssetId id)
Returns all revision tracked data for a given asset
|
List<AssetData> |
RevisionTrackingManagerImpl.getAll(AssetId id) |
Iterable<AssetData> |
ABTestAssetManager.getAllTests() |
String |
VisitorContext.getAttribute(String name) |
int |
EngageManager.getEffectiveRating(VisitorContext vc, AssetId aid, StringBuilder reason) |
List<Map<String,String>> |
VisitorContext.getHistory(String historyDef, long startdate, long enddate) |
int |
VisitorContext.getHistoryCount(String historyDef, long startdate, long enddate) |
double |
VisitorContext.getHistorySum(String historyDef, String field, long startdate, long enddate) |
List<AssetId> |
AssetData.getImmediateParents()
Returns the Asset Identifiers of immediate parents, if any.
|
List<AssetId> |
AssetDataImpl.getImmediateParents() |
List<AssetId> |
AssetData.getImmediateParents(String parentDefName)
Returns the Asset Identifiers of immediate parents, if any.
|
List<AssetId> |
AssetDataImpl.getImmediateParents(String parentDefName) |
protected com.openmarket.xcelerate.interfaces.IAsset |
ExtensiblePageWriteStrategy.getInstance(AssetData data, AssetDataWriteStrategy.AssetActionType type, List<String> ignoreAttributes, boolean insert) |
protected com.openmarket.xcelerate.interfaces.IAsset |
BasicAssetDataWriteStrategy.getInstance(AssetData data, AssetDataWriteStrategy.AssetActionType type, List<String> ignoreAttributes, boolean insert)
Gets an IAsset instance with the given asset data
|
protected com.openmarket.xcelerate.interfaces.IAsset |
AbstractSpecialAssetTypeWriteStrategy.getInstance(AssetData data, AssetDataWriteStrategy.AssetActionType type, List<String> ignoreAttributes, boolean insert) |
protected List<com.openmarket.xcelerate.interfaces.IAsset> |
BasicAssetDataWriteStrategy.getInstances(List<AssetData> data, AssetDataWriteStrategy.AssetActionType type, List<String> ignoreAttributes, boolean insert)
Gets a list of IAsset instances given a list of asset data
|
List<AssetId> |
AssetData.getParents()
Returns Asset identifiers of parent assets, if any.
|
List<AssetId> |
AssetDataImpl.getParents()
Returns Asset identifiers of parent assets, if any.
|
List<Long> |
ABTestAssetManager.getPublishTargetIds(Long testId) |
static AssetDataReadStrategy |
AssetDataStrategyFactory.getReadStrategy(ICS ics, String assettype, boolean isFlex)
get the proper read strategy for given asset type
|
List<RecommendedAssetId> |
AssetFacade.getRecommendations(String recommendationName, String alias, String profileName, Map<String,Object> profile, String segments, String sitename, boolean keepSegments)
Get a list of recommended assets
|
List<RecommendedAssetId> |
AssetFacadeImpl.getRecommendations(String recommendationName, String visitorId, String profileName, Map<String,Object> profile, String segments, String sitename, boolean keepSegments) |
List<RecommendedAssetId> |
EngageManager.getRecommendedAssets(VisitorContext vContext, String recommendationName, int maxcount, List<AssetId> filterOutAssets) |
List<AssetId> |
EngageManager.getSegmentIdsFor(VisitorContext vContext) |
List<String> |
EngageManager.getSegmentsFor(VisitorContext vContext) |
String |
AssetFacade.getSubtype(AssetId asset)
Get the subtype for a given asset
|
String |
AssetHelper.getSubtype(AssetId asset) |
String |
AssetFacadeImpl.getSubtype(AssetId asset) |
ABTestAssetManager.ABTestStateBean |
ABTestAssetManager.getTestState(Long testId) |
Iterable<ABTestAssetManager.ABTestStateBean> |
ABTestAssetManager.getTestStates() |
List<Integer> |
RevisionTrackingManager.getVersions(AssetId id)
Returns all available version numbers of tracked assets given an asset id.
|
List<Integer> |
RevisionTrackingManagerImpl.getVersions(AssetId id) |
VisitorContext |
EngageManager.getVisitorContext() |
VisitorContext |
EngageManager.getVisitorContext(String visitorId) |
static AssetDataWriteStrategy |
AssetDataStrategyFactory.getWriteStrategy(ICS ics, String assettype, boolean isFlex)
get the proper write strategy for given asset type
|
void |
AssetDataManager.insert(List<AssetData> data)
Inserts a given List of AssetData instances in the database and new assets will be created with the data from the list After the operation complete, the passed in AssetData in the list will be populated with the newly created Asset id
|
void |
AssetDataManagerImpl.insert(List<AssetData> data) |
boolean |
ABTestAssetManager.isTestField(String assetType, String assetId, String fieldName) |
void |
VisitorContext.linkWith(String alias) |
String |
LinkFactory.makeBlobLink(BlobLinkInfo linkInfo)
Create a blob link/url given blob table, key, col and value information
|
String |
AssetFacade.makeBlobLink(BlobLinkInfo linkInfo)
Generate a blob link given table, identifierColumnName, identifier, and columnname with given BlobLinkInfo
|
String |
AssetFacadeImpl.makeBlobLink(BlobLinkInfo linkInfo) |
String |
LinkFactory.makeLink(LinkInfo linkInfo)
Given an asset, a template and an LinkInfo, generate a link/url using Sites default standard url generating logic
|
String |
AssetFacade.makeLink(LinkInfo linkInfo)
Generate a link given asset, template name and LinkInfo
|
String |
AssetFacadeImpl.makeLink(LinkInfo linkInfo) |
String |
LinkFactory.makeLink(String pagename, LinkInfo linkInfo)
Generate a link for a pagename with given assetLinkInfo
|
MutableAssetData |
AssetDataManager.newAssetData(String assetTypeName, String subtype)
Create an empty instance of AssetData with empty instance of AttributeData
|
MutableAssetData |
AssetDataManagerImpl.newAssetData(String assetTypeName, String subtype) |
protected String |
BasicAssetDataReadStrategy.performQuery(Query query, String assettype, String subtype, AssetTypeDef def, boolean isFlex, List<String> uniqIds) |
void |
ExtensiblePageWriteStrategy.populateInstance(com.openmarket.xcelerate.interfaces.IAsset asset, AssetData data) |
void |
BasicAssetDataWriteStrategy.populateInstance(com.openmarket.xcelerate.interfaces.IAsset asset, AssetData data) |
void |
AssetDataWriteStrategy.populateInstance(com.openmarket.xcelerate.interfaces.IAsset asset, AssetData data) |
void |
AbstractSpecialAssetTypeWriteStrategy.populateInstance(com.openmarket.xcelerate.interfaces.IAsset asset, AssetData data) |
void |
ExtensiblePageWriteStrategy.populateInstance(com.openmarket.xcelerate.interfaces.IAsset asset, AssetData data, boolean filterNoSetAttributes, boolean verifyReferences) |
void |
BasicAssetDataWriteStrategy.populateInstance(com.openmarket.xcelerate.interfaces.IAsset asset, AssetData data, boolean filterNoSetAttributes, boolean verifyReferences) |
void |
AssetDataWriteStrategy.populateInstance(com.openmarket.xcelerate.interfaces.IAsset asset, AssetData data, boolean filterNoSetAttributes, boolean verifyReferences) |
void |
AbstractSpecialAssetTypeWriteStrategy.populateInstance(com.openmarket.xcelerate.interfaces.IAsset asset, AssetData data, boolean filterNoSetAttributes, boolean verifyReferences) |
List<Map> |
ContentQueryReader.read() |
Map |
AssetReader.read()
Read the asset bean with information specified.
|
List<Map> |
ContentQueryReaderImpl.read() |
AssetData |
AssetFacade.read(AssetId assetId, List<String> attributes)
Reads given set attribute data and returns an AssetData instance containing them.
|
AssetData |
AssetFacadeImpl.read(AssetId assetId, List<String> attributes) |
MutableAssetData |
BasicAssetDataReadStrategy.read(com.openmarket.xcelerate.interfaces.IAsset asset, AssetId id) |
MutableAssetData |
AssetDataReadStrategy.read(com.openmarket.xcelerate.interfaces.IAsset asset, AssetId id)
|
Iterable<AssetData> |
AssetDataManager.read(List<AssetId> ids)
Reads asset data for all given
AssetId s. |
Iterable<MutableAssetData> |
BasicAssetDataReadStrategy.read(List<AssetId> ids) |
Iterable<MutableAssetData> |
AssetDataReadStrategy.read(List<AssetId> ids)
Reads asset data for all given
AssetId s. |
Iterable<AssetData> |
AssetDataManagerImpl.read(List<AssetId> ids) |
Iterable<AssetData> |
AssetFacade.read(List<AssetId> assetIds, boolean immediateOnly)
Read a list of AssetData given a list of AssetIds
|
Iterable<AssetData> |
AssetFacadeImpl.read(List<AssetId> assetIds, boolean immediateOnly) |
Iterable<AssetData> |
AssetDataManager.read(Query query)
Reads all asset data that satisfies a given Query
|
Iterable<MutableAssetData> |
BasicAssetDataReadStrategy.read(Query query) |
Iterable<MutableAssetData> |
AssetDataReadStrategy.read(Query query)
Reads all asset data that satisfies a given Query
|
Iterable<AssetData> |
AssetDataManagerImpl.read(Query query)
read a list of Asset Data that satisfy the query.
|
AssetData |
AssetDataManager.readAttributes(AssetId id, List<String> attributeNames)
Reads given set attribute data and returns an AssetData instance containing them.
|
MutableAssetData |
BasicAssetDataReadStrategy.readAttributes(AssetId id, List<String> attributeNames) |
MutableAssetData |
AssetDataReadStrategy.readAttributes(AssetId id, List<String> attributeNames)
Reads given set attribute data and returns an AssetData instance containing them.
|
AssetData |
AssetDataManagerImpl.readAttributes(AssetId id, List<String> attributeNames) |
Iterable<MutableAssetData> |
AssetDataManager.readForUpdate(List<AssetId> ids)
NOTE: This method is not implemented yet.
|
Iterable<MutableAssetData> |
AssetDataManagerImpl.readForUpdate(List<AssetId> ids)
read a list of asset data to update
|
Iterable<MutableAssetData> |
AssetDataManager.readForUpdate(Query query)
Reads all asset data that satisfies a given Query and results in mutable results.
|
Iterable<MutableAssetData> |
AssetDataManagerImpl.readForUpdate(Query query) |
List<Map> |
RecommendationReader.readRecommendations(String recommendationName)
Get the list of recommended assets for the given recommendation in the given site for the current visitor or segments.
|
List<Map> |
RecommendationReader.readSegments()
Get a list of segments information with given visitor alias and visitor attributes
|
boolean |
ABTestAssetManager.removeReferences(AssetId staged, AssetId ref)
Removes the reference to an asset from the WCS_ABTest asset, if the asset has not already been published.
|
void |
TagManager.removeTag(String category, String tagName, AssetId asset)
Removes tag from asset.
|
List<Map> |
RecommendationReader.retainSegments()
Retain a list of matching segments for the given for the given visitor alias and visitor attributes
|
protected void |
RecommendationReadStrategy.retrieveSpecialAttributes(MutableAssetData data, com.openmarket.xcelerate.interfaces.IAsset asset, List<String> attributeNames) |
protected void |
HistoryGroupReadStrategy.retrieveSpecialAttributes(MutableAssetData data, com.openmarket.xcelerate.interfaces.IAsset asset, List<String> attributeNames) |
protected void |
ControllerAssetReadStrategy.retrieveSpecialAttributes(MutableAssetData data, com.openmarket.xcelerate.interfaces.IAsset asset, List<String> attributeNames) |
protected void |
CSElementReadStrategy.retrieveSpecialAttributes(MutableAssetData data, com.openmarket.xcelerate.interfaces.IAsset asset, List<String> attributeNames) |
void |
TagManager.saveTags(List<AssetId> assetIds, String[] newTags, String[] deleteTags)
Save and delete tags for multiple assets.
|
void |
TagManager.saveTags(List<Tag> tags)
Saves given list of tags.
|
List<Tag> |
TagManager.saveTags(List<Tag> tags, boolean isAssetSave, boolean isAfterPublish)
Saves given list of tags.
|
void |
VisitorContext.setAttribute(String name, String value) |
void |
VisitorContext.setHistoryAttribute(String definitionName, Map<String,String> values) |
void |
MutableAssetData.setParents(List<AssetId> ids)
Sets parent assets for this instance of AssetData
|
void |
AssetDataImpl.setParents(List<AssetId> id) |
void |
EngageManager.setSegmentsFor(VisitorContext vContext, List<String> segments) |
void |
EngageManager.setSegmentsFor(VisitorContext vContext, String segments) |
void |
ABTestAssetManager.setTestState(Long testId, String testState) |
void |
AssetDataManager.update(List<AssetData> data)
Updates a given list of AssetData in the database.
|
void |
AssetDataManagerImpl.update(List<AssetData> data) |
void |
AssetDataManager.update(List<AssetData> data, boolean keepCheckedOut)
Updates a given list of AssetData in the database.
|
void |
AssetDataManagerImpl.update(List<AssetData> data, boolean keepCheckedOut) |
void |
BasicAssetDataWriteStrategy.write(List<AssetData> data, AssetDataWriteStrategy.AssetActionType type) |
void |
AssetDataWriteStrategy.write(List<AssetData> data, AssetDataWriteStrategy.AssetActionType type)
Inserts a given Iterator of AssetData instances in the database.
|
void |
ExtensiblePageWriteStrategy.write(List<AssetData> data, AssetDataWriteStrategy.AssetActionType type, boolean keepCheckedOut) |
void |
BasicAssetDataWriteStrategy.write(List<AssetData> data, AssetDataWriteStrategy.AssetActionType type, boolean keepCheckedOut) |
void |
AssetDataWriteStrategy.write(List<AssetData> data, AssetDataWriteStrategy.AssetActionType type, boolean keepCheckedOut)
Inserts a given Iterator of AssetData instances in the database.
|
Constructor and Description |
---|
AssetDataImpl(AssetData copy)
Create an AssetData by copying an existing one
|
Modifier and Type | Method and Description |
---|---|
boolean |
AssetTypeDefManager.addAssociation(String assettype, String name, String description, String childtype, String depType, boolean multiValued, List<String> subtypes)
Add a named association to an asset type
|
boolean |
AssetTypeDefManagerImpl.addAssociation(String assettype, String name, String description, String childtype, String depType, boolean multiValues, List<String> subtypes) |
void |
AssetTypeDefManager.create(AssetTypeDef def)
This could only be used to create a flex definition.
|
void |
AssetTypeDefManagerImpl.create(AssetTypeDef def)
Creates an assetTypeDef in the database
|
boolean |
AssetTypeDefManager.createAssetMakerAssetType(String assetTypeName, String descriptorFileName, String descriptorXML, boolean addGeneralCategory, boolean enableAssetTypeIndex)
Creates a Content Server Asset Maker asset type using the passed in descriptor
|
boolean |
AssetTypeDefManagerImpl.createAssetMakerAssetType(String assetTypeName, String descriptorFileName, String descriptorXML, boolean addGeneralCategory, boolean enableAssetTypeIndex) |
boolean |
AssetTypeDefManager.createFlexFamily(FlexAssetFamilyInfo flexAssetFamilyInfo)
Creating a flex asset family in Content Server
|
boolean |
AssetTypeDefManagerImpl.createFlexFamily(FlexAssetFamilyInfo flexAssetFamilyInfo) |
void |
AssetTypeDefManager.delete(List<String> assetTypeNames)
NOTE: This method is not implemented yet.
|
void |
AssetTypeDefManagerImpl.delete(List<String> assetTypeNames)
Deletes asset types from the database and all their instances.
|
AssetTypeDef |
AssetTypeDefManager.findByName(String assetTypeName, String subtype)
Finds an asset type definition by its name The method expects a valid asset type to be passed in.
|
AssetTypeDef |
AssetTypeDefManagerImpl.findByName(String assetTypeName, String subtype)
Finds an asset type definition by its name
|
List<String> |
AssetTypeDefManager.getAssetTypes()
Returns all asset type names in the system.
|
List<String> |
AssetTypeDefManagerImpl.getAssetTypes() |
List<String> |
AssetTypeDefManager.getSubTypes(String assetType)
Returns subtype names given the asset type name If the asset type name specified is not existed in System, the method would return an empty List and will not throw exception.
|
List<String> |
AssetTypeDefManagerImpl.getSubTypes(String assetType) |
Modifier and Type | Method and Description |
---|---|
Condition |
ConditionFactory.createBetweenCondition(String attName, Object lower, Object upper)
default open between condition
|
Condition |
ConditionFactory.createBetweenCondition(String attName, Object lower, Object upper, boolean lowerEqual, boolean upperEqual)
default open between condition
|
static List<String> |
ConditionParser.parseBasicCondition(ICS ics, Long site, AssetTypeDef atd, Condition c, String prefix, FTValList attributes)
This method is used to convert a condition to an asset search format.
|
static com.openmarket.gator.interfaces.ISearchState |
ConditionParser.parseFlexCondition(ICS ics, AssetTypeDef atd, String attributeType, Condition c)
Parse a Condition and convert the passed in Condition to an ISearchState that could be used to search for flex assets
|
protected AssetSearchResult |
AssetSearcherImpl.performQuery(Query query, String assettype, String subtype, AssetTypeDef def) |
AssetSearchResult |
AssetSearcher.search(Query query)
Search Content Server database with given query
|
AssetSearchResult |
AssetSearcherImpl.search(Query query) |
Constructor and Description |
---|
AssetResultRowImpl(AssetId id, List<String> fields) |
Modifier and Type | Method and Description |
---|---|
Map |
NavigationReader.read()
Read the navigation hierarchy with information specified starting at the asset node specified.
|