|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.adobe.repository.RepositoryLoadProfile
public class RepositoryLoadProfile
Defines which object types and attributes are to be returned from (projected in) a repository query. A query includes any repository call that returns a resource or list of resources; queries include but are not limited to search methods.
Field Summary | |
---|---|
static boolean |
DEFAULT_EXCLUDE
Constant used to create a RepositoryLoadProfile that excludes everything by default. |
static boolean |
DEFAULT_PROJECT
Constant used to create a RepositoryLoadProfile that projects everything by default. |
static RepositoryLoadProfile |
PROJECT_ALL
Selects all attributes and resource types, known to the Repository, that apply to a given query. |
static RepositoryLoadProfile |
PROJECT_ALL_EXCEPT_RESOURCE_CONTENT_DATA
Selects all attributes and resource types except ResourceContent
data, known to the Repository, that apply to a given query. |
Constructor Summary | |
---|---|
RepositoryLoadProfile()
The default constructor. |
|
RepositoryLoadProfile(boolean defaultProject)
A constructor that can select all or no attributes and resource types for projection. |
|
RepositoryLoadProfile(QueryProfile queryProfile)
A constructor that uses a query profile. |
Method Summary | |
---|---|
void |
exclude(int type)
Excludes the selected resource object type or attribute from queries. |
void |
excludeAll()
Excludes all resource types and attributes from the query to which this RepositoryLoadProfile is passed. |
boolean |
getDefaultProject()
Retrieves the default projection state. |
boolean |
getFormTemplateIdString()
Deprecated. in 8.2.1. Use RepositoryLoadProfile#getResourceId() instead. |
boolean |
getLockDepth()
Gets the projection state of the Lock depth attribute. |
boolean |
getLockExpiryDate()
Gets the projection state of the Lock expiration date attribute. |
boolean |
getLockLockToken()
Gets the projection state of the Lock lock token attribute. |
boolean |
getLockOwnerUserId()
Gets the projection state of the Lock owner user identifier attribute. |
boolean |
getLockResourceId()
Gets the projection state of the Lock resource identifier attribute. |
boolean |
getLockType()
Gets the projection state of the Lock type attribute. |
boolean |
getRelationSourceObjectId()
Gets the projection state of the Relation source object identifier attribute. |
boolean |
getRelationTargetObjectId()
Gets the projection state of the Relation target object identifier attribute. |
boolean |
getRelationTrackTargetHead()
Gets the projection state of the Relation track target head attribute. |
boolean |
getRelationType()
Gets the projection state of the Relation type attribute. |
boolean |
getResourceAclId()
Gets the projection state for the Resource ACL identifier attribute. |
boolean |
getResourceAppstoreVersion()
Gets the projection state for the Resource application store version attribute. |
boolean |
getResourceContactId()
Gets the projection state for the Resource contact id attribute. |
boolean |
getResourceContactUserId()
Gets the projection state for the Resource contact user id attribute. |
boolean |
getResourceContent()
Gets the projection state for the Resource content attribute. |
boolean |
getResourceContentChecksum()
Deprecated. The checksum attribute was never publicly released. |
boolean |
getResourceContentContentUri()
Gets the projection state for the ResourceContent content URI attribute. |
boolean |
getResourceContentData()
Gets the projection state for the ResourceContent data attribute. |
boolean |
getResourceContentImplOid()
Gets the projection state for the Resource content object identifier attribute. |
boolean |
getResourceContentMimeType()
Gets the projection state for the ResourceContent MIME type attribute. |
boolean |
getResourceContentSize()
Gets the projection state for the ResourceContent size attribute. |
boolean |
getResourceCreatedBy()
Gets the projection state for the Resource created by attribute. |
boolean |
getResourceCreateTime()
Gets the projection state for the Resource create time attribute. |
boolean |
getResourceCustomStatus()
Gets the projection state for the Resource custom status attribute. |
boolean |
getResourceDeploymentStatus()
Gets the projection state for the Resource deployment status attribute. |
boolean |
getResourceDescription()
Gets the projection state for the Resource description attribute. |
boolean |
getResourceETag()
Gets the projection state for the Resource e-Tag attribute. |
boolean |
getResourceHead()
Gets the projection state for the Resource head attribute. |
boolean |
getResourceId()
Gets the projection state for the Resource identifier attribute. |
boolean |
getResourceLid()
Gets the projection state for the Resource Lid attribute. |
boolean |
getResourceLocks()
Gets the projection state for the Resource locks attribute. |
boolean |
getResourceMajorVersion()
Gets the projection state for the Resource major version attribute. |
boolean |
getResourceMinorVersion()
Gets the projection state for the Resource minor version attribute. |
boolean |
getResourceName()
Gets the projection state for the Resource name attribute. |
boolean |
getResourceObjectStatus()
Gets the projection state for the Resource object status attribute. |
boolean |
getResourceObjectType()
Gets the projection state for the Resource object type attribute. |
boolean |
getResourceOwnerUserId()
Gets the projection state for the Resource owner user identifier attribute. |
boolean |
getResourcePath()
Gets the projection state for the Resource path attribute. |
boolean |
getResourcePropertyName()
Gets the projection state for the ResourceProperty name attribute. |
boolean |
getResourcePropertyResourceId()
Gets the projection state for the ResourceProperty resource identifier attribute. |
boolean |
getResourcePropertyValue()
Gets the projection state for the ResourceProperty value attribute. |
boolean |
getResourceResourceProperties()
Gets the projection state for the Resource resource properties attribute. |
boolean |
getResourceUpdateTime()
Gets the projection state for the Resource update time attribute. |
boolean |
getTextFragmentType()
Deprecated. in 8.2.1, with no replacement. |
boolean |
isProjected(int type)
Retrieves the projection state of the supplied resource object type or attribute. |
void |
project(int type)
Projects the selected resource object type or attribute from queries. |
void |
projectAll()
Projects all resource types and attributes in the query to which this object is passed. |
void |
setLockDepth(boolean lockDepth)
Sets the projection state for the Lock depth attribute. |
void |
setLockExpiryDate(boolean lockExpiryDate)
Sets the projection state for the Lock expiration date attribute. |
void |
setLockLockToken(boolean lockLockToken)
Sets the projection state for the Lock lock token attribute. |
void |
setLockOwnerUserId(boolean lockOwnerUserId)
Sets the projection state for the Lock owner user identifier attribute. |
void |
setLockResourceId(boolean lockResourceId)
Sets the projection state for the Lock resource identifier attribute. |
void |
setLockType(boolean lockType)
Sets the projection state for the Lock type attribute. |
void |
setRelationSourceObjectId(boolean relationSourceObjectId)
Sets the projection state for the Relation source object identifier attribute. |
void |
setRelationTargetObjectId(boolean relationTargetObjectId)
Sets the projection state for the Relation target object identifier attribute. |
void |
setRelationTrackTargetHead(boolean relationTrackTargetHead)
Sets the projection state for the Relation track target head attribute. |
void |
setRelationType(boolean relationType)
Sets the projection state for the Relation type attribute. |
void |
setResourceAclId(boolean resourceAclId)
Sets the projection state for the Resource ACL identifier attribute. |
void |
setResourceAppstoreVersion(boolean ResourceAppstoreVersion)
Sets the projection state for the Resource application store version attribute. |
void |
setResourceContactId(boolean ResourceContactId)
Sets the projection state for the Resource contact id attribute. |
void |
setResourceContactUserId(boolean ResourceContactUserId)
Sets the projection state for the Resource contact user id attribute. |
void |
setResourceContent(boolean ResourceContent)
Sets the projection state for the Resource content attribute. |
void |
setResourceContentContentUri(boolean resourceContentContentUri)
Sets the projection state for the ResourceContent content URI attribute. |
void |
setResourceContentData(boolean resourceContentData)
Sets the projection state for the ResourceContent data attribute. |
void |
setResourceContentMimeType(boolean resourceContentMimeType)
Sets the projection state for the ResourceContent mime type attribute. |
void |
setResourceContentSize(boolean resourceContentSize)
Sets the projection state for the ResourceContent size attribute. |
void |
setResourceCreatedBy(boolean ResourceCreatedBy)
Sets the projection state for the Resource created by attribute. |
void |
setResourceCreateTime(boolean ResourceCreateTime)
Sets the projection state for the Resource create time attribute. |
void |
setResourceCustomStatus(boolean ResourceCustomStatus)
Sets the projection state for the Resource custom status attribute. |
void |
setResourceDeploymentStatus(boolean ResourceDeploymentStatus)
Sets the projection state for the Resource deployment status attribute. |
void |
setResourceDescription(boolean ResourceDescription)
Sets the projection state for the Resource description attribute. |
void |
setResourceETag(boolean ResourceETag)
Sets the projection state for the Resource e-tag attribute. |
void |
setResourceHead(boolean ResourceHead)
Sets the projection state for the Resource head attribute. |
void |
setResourceId(boolean resourceId)
Sets the projection state for the Resource identifier attribute. |
void |
setResourceLid(boolean ResourceLid)
Sets the projection state for the Resource Lid attribute. |
void |
setResourceLocks(boolean ResourceLocks)
Sets the projection state for the Resource locks attribute. |
void |
setResourceMajorVersion(boolean ResourceMajorVersion)
Sets the projection state for the Resource major version attribute. |
void |
setResourceMinorVersion(boolean ResourceMinorVersion)
Sets the projection state for the Resource minor version attribute. |
void |
setResourceName(boolean ResourceName)
Sets the projection state for the Resource name attribute. |
void |
setResourceObjectStatus(boolean ResourceObjectStatus)
Sets the projection state for the Resource object status attribute. |
void |
setResourceObjectType(boolean ResourceObjectType)
Sets the projection state for the Resource object type attribute. |
void |
setResourceOwnerUserId(boolean ResourceOwnerUserId)
Sets the projection state for the Resource owner user identifier attribute. |
void |
setResourcePath(boolean ResourcePath)
Sets the projection state for the Resource path attribute. |
void |
setResourcePropertyName(boolean resourcePropertyName)
Sets the projection state for the ResourceProperty name attribute. |
void |
setResourcePropertyResourceId(boolean resourcePropertyResourceId)
Sets the projection state for the ResourceProperty resource identifier attribute. |
void |
setResourcePropertyValue(boolean resourcePropertyValue)
Sets the projection state for the ResourceProperty value attribute. |
void |
setResourceResourceProperties(boolean ResourceResourceProperties)
Sets the projection state for the Resource resource properties attribute. |
void |
setResourceUpdateTime(boolean ResourceUpdateTime)
Sets the projection state for the Resource update time attribute. |
void |
setTextFragmentType(boolean textFragmentType)
Deprecated. in 8.2.1, with no replacement. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final boolean DEFAULT_PROJECT
RepositoryLoadProfile
that projects everything by default.
public static final boolean DEFAULT_EXCLUDE
RepositoryLoadProfile
that excludes everything by default.
public static final RepositoryLoadProfile PROJECT_ALL
public static final RepositoryLoadProfile PROJECT_ALL_EXCEPT_RESOURCE_CONTENT_DATA
ResourceContent
data, known to the Repository, that apply to a given query.
Constructor Detail |
---|
public RepositoryLoadProfile()
RepositoryLoadProfile.DEFAULT_PROJECT
constant.
public RepositoryLoadProfile(boolean defaultProject)
defaultProject
- If true
, all attributes and resource
types known to the Repository are selected for return. If it is false
,
none are selected.public RepositoryLoadProfile(QueryProfile queryProfile)
queryProfile
- The query profile to copy.Method Detail |
---|
public void projectAll()
This method is equivalent to calling new RepositoryLoadProfile(true)
.
public void excludeAll()
This method is equivalent to calling new RepositoryLoadProfile(false)
.
public void project(int type)
// project the Resource object. profile.project(Resource.OBJECT_TYPE_RESOURCE); // project the Resource attribute identifier. profile.project(Resource.LOAD_ID);
type
- A one-based load profile index.public void exclude(int type)
type
- A one-based load profile index.public boolean isProjected(int type)
type
- A one-based load profile index.
true
if the attribute or object type represented by type is projected, false
otherwise.public boolean getDefaultProject()
true
if the profile's current state is to project by default, false
otherwise.public void setLockResourceId(boolean lockResourceId)
Lock
resource identifier attribute.
lockResourceId
- true
to project, false
to exclude.public void setLockOwnerUserId(boolean lockOwnerUserId)
Lock
owner user identifier attribute.
lockOwnerUserId
- true
to project, false
to exclude.public void setLockType(boolean lockType)
Lock
type attribute.
lockType
- true
to project, false
to exclude.public void setLockDepth(boolean lockDepth)
Lock
depth attribute.
lockDepth
- true
to project, false
to exclude.public void setLockLockToken(boolean lockLockToken)
Lock
lock token attribute.
lockLockToken
- true
to project, false
to exclude.public void setLockExpiryDate(boolean lockExpiryDate)
Lock
expiration date attribute.
lockExpiryDate
- true
to project, false
to exclude.public void setRelationType(boolean relationType)
Relation
type attribute.
relationType
- true
to project, false
to exclude.public void setRelationTrackTargetHead(boolean relationTrackTargetHead)
Relation
track target head attribute.
relationTrackTargetHead
- true
to project, false
to exclude.public void setRelationSourceObjectId(boolean relationSourceObjectId)
Relation
source object identifier attribute.
relationSourceObjectId
- true
to project, false
to exclude.public void setRelationTargetObjectId(boolean relationTargetObjectId)
Relation
target object identifier attribute.
relationTargetObjectId
- true
to project, false
to exclude.public void setResourceContentData(boolean resourceContentData)
ResourceContent
data attribute.
resourceContentData
- true
to project, false
to exclude.public void setResourceContentMimeType(boolean resourceContentMimeType)
ResourceContent
mime type attribute.
resourceContentMimeType
- true
to project, false
to exclude.public void setResourceContentSize(boolean resourceContentSize)
ResourceContent
size attribute.
resourceContentSize
- true
to project, false
to exclude.public void setResourceContentContentUri(boolean resourceContentContentUri)
ResourceContent
content URI attribute.
resourceContentContentUri
- true
to project, false
to exclude.public void setResourceId(boolean resourceId)
Resource
identifier attribute.
resourceId
- true
to project, false
to exclude.public void setResourceLid(boolean ResourceLid)
Resource
Lid attribute.
ResourceLid
- true
to project, false
to exclude.public void setResourceObjectType(boolean ResourceObjectType)
Resource
object type attribute.
ResourceObjectType
- true
to project, false
to exclude.public void setResourceObjectStatus(boolean ResourceObjectStatus)
Resource
object status attribute.
ResourceObjectStatus
- true
to project, false
to exclude.public void setResourceDeploymentStatus(boolean ResourceDeploymentStatus)
Resource
deployment status attribute.
ResourceDeploymentStatus
- true
to project, false
to exclude.public void setResourceCustomStatus(boolean ResourceCustomStatus)
Resource
custom status attribute.
ResourceCustomStatus
- true
to project, false
to exclude.public void setResourceAppstoreVersion(boolean ResourceAppstoreVersion)
Resource
application store version attribute.
ResourceAppstoreVersion
- true
to project, false
to exclude.public void setResourceDescription(boolean ResourceDescription)
Resource
description attribute.
ResourceDescription
- true
to project, false
to exclude.public void setResourceMajorVersion(boolean ResourceMajorVersion)
Resource
major version attribute.
ResourceMajorVersion
- true
to project, false
to exclude.public void setResourceMinorVersion(boolean ResourceMinorVersion)
Resource
minor version attribute.
ResourceMinorVersion
- true
to project, false
to exclude.public void setResourceOwnerUserId(boolean ResourceOwnerUserId)
Resource
owner user identifier attribute.
ResourceOwnerUserId
- true
to project, false
to exclude.public void setResourceETag(boolean ResourceETag)
Resource
e-tag attribute.
ResourceETag
- true
to project, false
to exclude.public void setResourceName(boolean ResourceName)
Resource
name attribute.
ResourceName
- true
to project, false
to exclude.public void setResourcePath(boolean ResourcePath)
Resource
path attribute.
ResourcePath
- true
to project, false
to exclude.public void setResourceContactId(boolean ResourceContactId)
Resource
contact id attribute.
ResourceContactId
- true
to project, false
to exclude.public void setResourceContactUserId(boolean ResourceContactUserId)
Resource
contact user id attribute.
ResourceContactUserId
- true
to project, false
to exclude.public void setResourceCreatedBy(boolean ResourceCreatedBy)
Resource
created by attribute.
ResourceCreatedBy
- true
to project, false
to exclude.public void setResourceHead(boolean ResourceHead)
Resource
head attribute.
ResourceHead
- true
to project, false
to exclude.public void setResourceAclId(boolean resourceAclId)
Resource
ACL identifier attribute.
resourceAclId
- true
to project, false
to exclude.public void setResourceUpdateTime(boolean ResourceUpdateTime)
Resource
update time attribute.
ResourceUpdateTime
- true
to project, false
to exclude.public void setResourceCreateTime(boolean ResourceCreateTime)
Resource
create time attribute.
ResourceCreateTime
- true
to project, false
to exclude.public void setResourceResourceProperties(boolean ResourceResourceProperties)
Resource
resource properties attribute.
ResourceResourceProperties
- true
to project, false
to exclude.public void setResourceLocks(boolean ResourceLocks)
Resource
locks attribute.
ResourceLocks
- true
to project, false
to exclude.public void setResourceContent(boolean ResourceContent)
Resource
content attribute.
ResourceContent
- true
to project, false
to exclude.public void setResourcePropertyResourceId(boolean resourcePropertyResourceId)
ResourceProperty
resource identifier attribute.
resourcePropertyResourceId
- true
to project, false
to exclude.public void setResourcePropertyName(boolean resourcePropertyName)
ResourceProperty
name attribute.
resourcePropertyName
- true
to project, false
to exclude.public void setResourcePropertyValue(boolean resourcePropertyValue)
ResourceProperty
value attribute.
resourcePropertyValue
- true
to project, false
to exclude.public boolean getResourceAclId()
Resource
ACL identifier attribute.
true
to project, false
to exclude.public boolean getResourceAppstoreVersion()
Resource
application store version attribute.
true
to project, false
to exclude.public boolean getResourceContent()
Resource
content attribute.
true
to project, false
to exclude.public boolean getResourceContentImplOid()
Resource
content object identifier attribute.
true
to project, false
to exclude.public boolean getResourceCreatedBy()
Resource
created by attribute.
true
to project, false
to exclude.public boolean getResourceCreateTime()
Resource
create time attribute.
true
to project, false
to exclude.public boolean getResourceCustomStatus()
Resource
custom status attribute.
true
to project, false
to exclude.public boolean getResourceDeploymentStatus()
Resource
deployment status attribute.
true
to project, false
to exclude.public boolean getResourceDescription()
Resource
description attribute.
true
to project, false
to exclude.public boolean getResourceETag()
Resource
e-Tag attribute.
true
to project, false
to exclude.public boolean getResourceHead()
Resource
head attribute.
true
to project, false
to exclude.public boolean getResourceId()
Resource
identifier attribute.
true
to project, false
to exclude.public boolean getResourceLid()
Resource
Lid attribute.
true
to project, false
to exclude.public boolean getResourceLocks()
Resource
locks attribute.
true
to project, false
to exclude.public boolean getResourceMajorVersion()
Resource
major version attribute.
true
to project, false
to exclude.public boolean getResourceMinorVersion()
Resource
minor version attribute.
true
to project, false
to exclude.public boolean getResourceName()
Resource
name attribute.
true
to project, false
to exclude.public boolean getResourceObjectStatus()
Resource
object status attribute.
true
to project, false
to exclude.public boolean getResourceObjectType()
Resource
object type attribute.
true
to project, false
to exclude.public boolean getResourceOwnerUserId()
Resource
owner user identifier attribute.
true
to project, false
to exclude.public boolean getResourcePath()
Resource
path attribute.
true
to project, false
to exclude.public boolean getResourceResourceProperties()
Resource
resource properties attribute.
true
to project, false
to exclude.public boolean getResourceUpdateTime()
Resource
update time attribute.
true
to project, false
to exclude.public boolean getResourceContactId()
Resource
contact id attribute.
true
to project, false
to exclude.public boolean getResourceContactUserId()
Resource
contact user id attribute.
true
to project, false
to exclude.public void setTextFragmentType(boolean textFragmentType)
TextFragment
type attribute.
textFragmentType
- true
to project, false
to exclude.public boolean getFormTemplateIdString()
FormTemplate
identifier attribute.
true
to project, false
to exclude.public boolean getLockResourceId()
Lock
resource identifier attribute.
true
to project, false
to exclude.public boolean getLockOwnerUserId()
Lock
owner user identifier attribute.
true
to project, false
to exclude.public boolean getLockType()
Lock
type attribute.
true
to project, false
to exclude.public boolean getLockDepth()
Lock
depth attribute.
true
to project, false
to exclude.public boolean getLockLockToken()
Lock
lock token attribute.
true
to project, false
to exclude.public boolean getLockExpiryDate()
Lock
expiration date attribute.
true
to project, false
to exclude.public boolean getRelationType()
Relation
type attribute.
true
to project, false
to exclude.public boolean getRelationTrackTargetHead()
Relation
track target head attribute.
true
to project, false
to exclude.public boolean getRelationSourceObjectId()
Relation
source object identifier attribute.
true
to project, false
to exclude.public boolean getRelationTargetObjectId()
Relation
target object identifier attribute.
true
to project, false
to exclude.public boolean getResourcePropertyResourceId()
ResourceProperty
resource identifier attribute.
true
to project, false
to exclude.public boolean getResourcePropertyName()
ResourceProperty
name attribute.
true
to project, false
to exclude.public boolean getResourcePropertyValue()
ResourceProperty
value attribute.
true
to project, false
to exclude.public boolean getTextFragmentType()
TextFragment
type attribute.
true
to project, false
to exclude.public boolean getResourceContentData()
ResourceContent
data attribute.
true
to project, false
to exclude.public boolean getResourceContentMimeType()
ResourceContent
MIME type attribute.
true
to project, false
to exclude.public boolean getResourceContentSize()
ResourceContent
size attribute.
true
to project, false
to exclude.public boolean getResourceContentChecksum()
ResourceContent
checksum attribute.
public boolean getResourceContentContentUri()
ResourceContent
content URI attribute.
true
to project, false
to exclude.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |