Skip navigation links

com.flashline.registry.openapi.query
Class AssetCriteria

java.lang.Object
com.flashline.registry.openapi.query.SearchTermGroup
com.flashline.registry.openapi.query.AssetCriteria

All Implemented Interfaces:

java.io.Serializable

public class AssetCriteria

extends SearchTermGroup

implements java.io.Serializable

This class is used to specify search criteria for assets. The properties id, hash, name, version, description, keyword, general, assettypeid, categorizatoin, and uniqueelement are convenience properties that will automatically be translated into instances of SearchTerm.

The property exactMatch determines if the search will require exact matches in order to match on an Asset. For example, if exactMatch is FALSE, then setting the name property to "foo" would match on an Asset named "foo" and also on an asset named "foobar".

It is also possible to interact with the AssetFactory's low-level searching capabilities directly by manually creating SearchTerm instances and adding them to an AssetCriteria. The following list describes valid SearchTerm keys for performing extended Asset searches. Note that when manually specifying SearchTerms, the operator is always assumed to be EQUALS and all SearchTerms are combined using an AND operation. Certain SearchTerm keys do support the IN operator. These are id, assettypeid, createdbyid, and submittedbyid.

• id - Search for the specified ID.
• /asset/mandatory-data/name - Search for the specified name.
• /asset/mandatory-data/version - Search for the specified version string.
• assettypeid - Search for Assets of an AssetType with the spefied ID.
• archetypeid - Search for Assets of an AssetType with Archetype with specified ID.
• /asset/mandatory-data/description - Search for the specified descrition.
• /asset/mandatory-data/keywords/keyword - Search for the specified keyword.
• /asset/custom-data/hashInfos/hashInfo - Search for the specified SFID.
• /asset/mandatory-data/producing-projects/project - Search for assets that have a producing project with the specified ID.
• general
• categorization.# - Search for Assets with CategorizaionType ID=#, and an assigned Categorization equal to the value of the SearchTerm.
• /asset/custom-data/hashInfos/hashInfo - Search for the specified SFID.
• /asset/custom-data/* - Search for asset with the specified element in customdata equal to the value specified in the SearchTerm. * is the xpath of the custom data field to search. For customdata tables, the xpath will be something like: tablename/rowname/columname. Examples:
  • /asset/customdata/endpoint-uri
  • /asset/customdata/users/user/firstname
• metadata.x/y - Search for asset with the specified element in a MetadataEntry, equal to the value specified in the SearchTerm. x is the name of the metadataentry and y is the xpath of the MetadataEntry content search. Example: metadata.internal.introspector.store/sync/Namespace
• status - Search on the active status of the Asset. Value should be one of 0=Active, 10=Inactive, 20=Retired, 30=Deleted, 40=Incomplete.
• uniqueelement - Search for an asset whos unique element is equal to the SearchTerm's value
• underconstruction - Search for assets that have a status of UNDERCONSTRUCTION
• submission - Search for assets that have a status of SUBMITTED.
• rejected - Search for assets that have a status of REJECTED.
• queued - Search for assets that have a status of QUEUED.
• registered - Search for assets that havea a status of REGISTERED.
• createdbyid - Search for assets that were created by the specified user ID.
• submittedbyid - Search for assetds that were submitted by the specified ID.
• assetstatus - Search for an asset with a registration status equal to the specified value. One of 0=undefined, 10=unsubmitted, 50=submitted, 51=pending review, 52=under review, 55=rejected, 100=registered.
• relatedAsset.* - Search for assets with the named relationship=*, for the specified asset by ID. For the 'next-version' of this asset: Key='relatedAsset.next-version', Value=(this-asset-id).
• relatedToAsset.* - Search for assets with the named relationship=*, to the specified asset by ID. For assets which define this asset to be its next-version: Key='relatedToAsset.next-version', Value=(this-asset-id).
• uuid - Search for the asset with the specified UUID.
• offset - the starting index (zero-based) from the matching results
• limit - the number of results to return, starting at the starting index specified by "start"

The asset criteria object model can accept SearchTerm objects as well as objects that extend SearchTerm. The DateRangeSearchTerm object is used to specify date criteria. The date inputs must conform to the Short Date format specified in the system settings. The TabStatusSearchTerm will search for assets with a specified tab status and updated date. This date input must also conform to the Short Date format.

NOTE: The criteria object model is currently moving to a more flexible representation of terms and grouping. As they occur, these changes will affect the availability of certain API features when executing a query using a criteria object. The Asset subsystem only directly evaluates the AssetCriteria, and does not make use of the extended capabilities of the underlying SearchTermGroup, unless otherwise noted in this documentation.

See Also:

Serialized Form

Constructor Summary

AssetCriteria()

AssetCriteria(long IDCriteria, java.lang.String[] SFIDCriteria, java.lang.String UUIDCriteria, long assetTypeCriteria, java.lang.String browsableOnlyCriteria, Categorization categorizationCriteria, java.lang.String descriptionCriteria, java.lang.String exactMatchCriteria, java.lang.String generalCriteria, java.lang.String keywordCriteria, java.lang.String nameCriteria, java.lang.String uniqueElementCriteria, java.lang.String versionCriteria)

Method Summary

boolean	equals(java.lang.Object obj)
long	getAssetTypeCriteria() Gets the assetTypeCriteria value for this AssetCriteria.
java.lang.String	getBrowsableOnlyCriteria() Gets the browsableOnlyCriteria value for this AssetCriteria.
Categorization	getCategorizationCriteria() Gets the categorizationCriteria value for this AssetCriteria.
java.lang.String	getDescriptionCriteria() Gets the descriptionCriteria value for this AssetCriteria.
static org.apache.axis.encoding.Deserializer	getDeserializer(java.lang.String mechType, java.lang.Class _javaType, javax.xml.namespace.QName _xmlType) Get Custom Deserializer
java.lang.String	getExactMatchCriteria() Gets the exactMatchCriteria value for this AssetCriteria.
java.lang.String	getGeneralCriteria() Gets the generalCriteria value for this AssetCriteria.
long	getIDCriteria() Gets the IDCriteria value for this AssetCriteria.
java.lang.String	getKeywordCriteria() Gets the keywordCriteria value for this AssetCriteria.
java.lang.String	getNameCriteria() Gets the nameCriteria value for this AssetCriteria.
static org.apache.axis.encoding.Serializer	getSerializer(java.lang.String mechType, java.lang.Class _javaType, javax.xml.namespace.QName _xmlType) Get Custom Serializer
java.lang.String[]	getSFIDCriteria() Gets the SFIDCriteria value for this AssetCriteria.
static org.apache.axis.description.TypeDesc	getTypeDesc() Return type metadata object
java.lang.String	getUniqueElementCriteria() Set unique element criteria.
java.lang.String	getUUIDCriteria() Gets the UUIDCriteria value for this AssetCriteria.
java.lang.String	getVersionCriteria() Set search string that must be present in the version.
int	hashCode()
void	setAssetTypeCriteria(long assetTypeCriteria) Set asset type that must be assigned.
void	setBrowsableOnlyCriteria(java.lang.String browsableOnlyCriteria) Set whether to return only browsable assets.
void	setCategorizationCriteria(Categorization categorizationCriteria) Set categorization that must be assigned.
void	setDescriptionCriteria(java.lang.String descriptionCriteria) Set search string that must be present in the description.
void	setExactMatchCriteria(java.lang.String exactMatchCriteria) Set whether to return only exact matches.
void	setGeneralCriteria(java.lang.String generalCriteria) Set search string that must be present in name, version, description, keywords, categorizations or indexed fields
void	setIDCriteria(long IDCriteria) Set ID of Asset to find.
void	setKeywordCriteria(java.lang.String keywordCriteria) Set search string that must be present in the Keyword.
void	setNameCriteria(java.lang.String nameCriteria) Set search string that must be present in the name.
void	setSFIDCriteria(java.lang.String[] SFIDCriteria) Set list of hash values to search for
void	setUniqueElementCriteria(java.lang.String uniqueElementCriteria) Sets the uniqueElementCriteria value for this AssetCriteria.
void	setUUIDCriteria(java.lang.String UUIDCriteria) Set UUID string criteria.
void	setVersionCriteria(java.lang.String versionCriteria) Sets the versionCriteria value for this AssetCriteria.

Methods inherited from class com.flashline.registry.openapi.query.SearchTermGroup

getOrderBy, getQualifier, getSearchTermGroups, getSearchTerms, getSupportedKeys, setOrderBy, setQualifier, setSearchTermGroups, setSearchTerms, setSupportedKeys

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AssetCriteria

public AssetCriteria()

AssetCriteria

public AssetCriteria(long IDCriteria,
                     java.lang.String[] SFIDCriteria,
                     java.lang.String UUIDCriteria,
                     long assetTypeCriteria,
                     java.lang.String browsableOnlyCriteria,
                     Categorization categorizationCriteria,
                     java.lang.String descriptionCriteria,
                     java.lang.String exactMatchCriteria,
                     java.lang.String generalCriteria,
                     java.lang.String keywordCriteria,
                     java.lang.String nameCriteria,
                     java.lang.String uniqueElementCriteria,
                     java.lang.String versionCriteria)

Method Detail

getIDCriteria

public long getIDCriteria()

Gets the IDCriteria value for this AssetCriteria.

Returns:

IDCriteria

setIDCriteria

public void setIDCriteria(long IDCriteria)

Set ID of Asset to find.

Parameters:

pID - The ID of the asset to find.

getSFIDCriteria

public java.lang.String[] getSFIDCriteria()

Gets the SFIDCriteria value for this AssetCriteria.

Returns:

SFIDCriteria

setSFIDCriteria

public void setSFIDCriteria(java.lang.String[] SFIDCriteria)

Set list of hash values to search for

Parameters:

pSFIDs - List of hash values

getUUIDCriteria

public java.lang.String getUUIDCriteria()

Gets the UUIDCriteria value for this AssetCriteria.

Returns:

UUIDCriteria

setUUIDCriteria

public void setUUIDCriteria(java.lang.String UUIDCriteria)

Set UUID string criteria.

Parameters:

pUniqueElement - The UUID string criteria

getAssetTypeCriteria

public long getAssetTypeCriteria()

Gets the assetTypeCriteria value for this AssetCriteria.

Returns:

assetTypeCriteria

setAssetTypeCriteria

public void setAssetTypeCriteria(long assetTypeCriteria)

Set asset type that must be assigned.

Parameters:

pAssetTypeID - the id of the asset type

getBrowsableOnlyCriteria

public java.lang.String getBrowsableOnlyCriteria()

Gets the browsableOnlyCriteria value for this AssetCriteria.

Returns:

browsableOnlyCriteria

setBrowsableOnlyCriteria

public void setBrowsableOnlyCriteria(java.lang.String browsableOnlyCriteria)

Set whether to return only browsable assets. This behavior mimics how asset searches work in the Oracle Enterprise Repository user interface. For example, only registered assets will be returned unless the Assets-In-Progress feature is enabled.

Parameters:

pBrowsableOnly - true/false whether to return only browsable assets

getCategorizationCriteria

public Categorization getCategorizationCriteria()

Gets the categorizationCriteria value for this AssetCriteria.

Returns:

categorizationCriteria

setCategorizationCriteria

public void setCategorizationCriteria(Categorization categorizationCriteria)

Set categorization that must be assigned.

Parameters:

pCategorization - the categorization object

getDescriptionCriteria

public java.lang.String getDescriptionCriteria()

Gets the descriptionCriteria value for this AssetCriteria.

Returns:

descriptionCriteria

setDescriptionCriteria

public void setDescriptionCriteria(java.lang.String descriptionCriteria)

Set search string that must be present in the description.

Parameters:

pDescription - Description search string

getExactMatchCriteria

public java.lang.String getExactMatchCriteria()

Gets the exactMatchCriteria value for this AssetCriteria.

Returns:

exactMatchCriteria

setExactMatchCriteria

public void setExactMatchCriteria(java.lang.String exactMatchCriteria)

Set whether to return only exact matches.

Parameters:

pExactMatch - true/false whether to return only exact matches

getGeneralCriteria

public java.lang.String getGeneralCriteria()

Gets the generalCriteria value for this AssetCriteria.

Returns:

generalCriteria

setGeneralCriteria

public void setGeneralCriteria(java.lang.String generalCriteria)

Set search string that must be present in name, version, description, keywords, categorizations or indexed fields

Parameters:

pGeneral - The general criteria.

getKeywordCriteria

public java.lang.String getKeywordCriteria()

Gets the keywordCriteria value for this AssetCriteria.

Returns:

keywordCriteria

setKeywordCriteria

public void setKeywordCriteria(java.lang.String keywordCriteria)

Set search string that must be present in the Keyword.

Parameters:

pKeyword - Keyword search string.

getNameCriteria

public java.lang.String getNameCriteria()

Gets the nameCriteria value for this AssetCriteria.

Returns:

nameCriteria

setNameCriteria

public void setNameCriteria(java.lang.String nameCriteria)

Set search string that must be present in the name.

Parameters:

pName - The name of the asset to find.

getUniqueElementCriteria

public java.lang.String getUniqueElementCriteria()

Set unique element criteria. The Unique element option must be enabled for anything to be found

Parameters:

pUniqueElement - The unique element criteria

setUniqueElementCriteria

public void setUniqueElementCriteria(java.lang.String uniqueElementCriteria)

Sets the uniqueElementCriteria value for this AssetCriteria.

Parameters:

uniqueElementCriteria -

getVersionCriteria

public java.lang.String getVersionCriteria()

Set search string that must be present in the version.

Parameters:

pVersion - Version search string

setVersionCriteria

public void setVersionCriteria(java.lang.String versionCriteria)

Sets the versionCriteria value for this AssetCriteria.

Parameters:

versionCriteria -

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class SearchTermGroup

hashCode

public int hashCode()

Overrides:

hashCode in class SearchTermGroup

getTypeDesc

public static org.apache.axis.description.TypeDesc getTypeDesc()

Return type metadata object

getSerializer

public static org.apache.axis.encoding.Serializer getSerializer(java.lang.String mechType,
                                                                java.lang.Class _javaType,
                                                                javax.xml.namespace.QName _xmlType)

Get Custom Serializer

getDeserializer

public static org.apache.axis.encoding.Deserializer getDeserializer(java.lang.String mechType,
                                                                    java.lang.Class _javaType,
                                                                    javax.xml.namespace.QName _xmlType)

Get Custom Deserializer

Skip navigation links