Project: stp

com.ibm.rational.wvcm.stp.cq
Interface CqAttachmentFolder

All Superinterfaces:
CqResource, CqUserDbMember, Folder, Resource, StpResource

public interface CqAttachmentFolder
extends CqUserDbMember, Folder

A folder that contains the attachments associated with an attachment field of a record and, hence, the value of such a record field. Attachments are added to a record by creating an attachment resource in an CqAttachmentFolder. They are removed by deleting the attachment resources from their respective attachment folders.

Attachment folders can neither be created nor deleted independent of the record with which they are associated. They are the one and only value of their attachment field for the lifetime of that field. Only their contents may be altered. And their content is altered by executing doCreateAttachment and doUnbindAll operations on the attachment resources that are contained by the attachment folder.

The user-friendly specification for the location of an attachment folder has the form

  cq.record:<record-type>/<record-id>/<field-name>@<db-set>/<user-db>
 
where the /<field-name> segment identifies a field of type CqFieldValue.ValueType.ATTACHMENT_LIST


Nested Class Summary
 
Nested classes/interfaces inherited from interface com.ibm.rational.wvcm.stp.StpResource
StpResource.UnsupportedProperty
 
Nested classes/interfaces inherited from interface javax.wvcm.Resource
Resource.CopyFlag
 
Nested classes/interfaces inherited from interface javax.wvcm.Folder
Folder.BindFlag, Folder.RebindFlag
 
Field Summary
static PropertyNameList.PropertyName<ResourceList<CqAttachment>> ATTACHMENT_LIST
          The members of this folder.
static PropertyNameList.PropertyName<CqFieldValue<CqAttachmentFolder>> FIELD
          The record field that contains this attachment folder as its value.
static PropertyNameList.PropertyName<CqRecord> RECORD
          The parent record of this folder.
static PropertyNameList.PropertyName<CqRecordType> RECORD_TYPE
          A CqRecordType proxy for the record-type resource that defines the parent record of this attachment folder.
 
Fields inherited from interface CqUserDbMember
DB_SET, USER_DB
 
Fields inherited from interface com.ibm.rational.wvcm.stp.StpResource
ALL_PROPERTIES, AUTHENTICATION_REALM, CREATOR_GROUP_NAME, CREATOR_LOGIN_NAME, EFFICIENT_LOCATION, INVALID_PROPERTIES, REPOSITORY, STABLE_LOCATION, USER_FRIENDLY_LOCATION
 
Fields inherited from interface javax.wvcm.Resource
ALL_CUSTOM_PROPERTIES, COMMENT, CONTENT_CHARACTER_SET, CONTENT_IDENTIFIER, CONTENT_LANGUAGE, CONTENT_LENGTH, CONTENT_TYPE, CREATION_DATE, CREATOR_DISPLAY_NAME, DISPLAY_NAME, IS_EXECUTABLE, LAST_MODIFIED, PARENT_LIST, PATHNAME_LOCATION, PROVIDER_LIST, RESOURCE_IDENTIFIER, WORKSPACE_FOLDER_LIST
 
Fields inherited from interface javax.wvcm.Folder
CHILD_LIST, CHILD_MAP
 
Method Summary
 ResourceList<CqAttachment> getAttachmentList()
          Returns the value of the ATTACHMENT_LIST property as defined by this proxy.
 CqFieldValue<?> getField()
          Returns the value of the FIELD property as defined by this proxy.
 CqRecord getRecord()
          Returns the value of the RECORD property as defined by this proxy.
 CqRecordType getRecordType()
          A CqRecordType proxy for the record-type resource that defines what kind of record this is.
 
Methods inherited from interface CqUserDbMember
getDbSet, getUserDb
 
Methods inherited from interface CqResource
cqProvider, getComment, getContentCharacterSet, getContentIdentifier, getContentLanguage, getContentLength, getContentType, getCreationDate, getCreatorDisplayName, getCreatorGroupName, getCreatorLoginName, getIsExecutable, getLastModified, getProviderList, getWorkspaceFolderList, setComment, setContentCharacterSet, setContentLanguage, setContentType, setCreatorDisplayName, setIsExecutable
 
Methods inherited from interface com.ibm.rational.wvcm.stp.StpResource
doReadProperties, equals, getAllProperties, getAuthenticationRealm, getCustomProperties, getEfficientLocation, getInvalidProperties, getMetaProperties, getPropertyException, getRepository, getResourceError, getResourceIdentifier, getStableLocation, getUserFriendlyLocation, hashCode, hasProperties, initMetaProperty, proxyType, stpLocation, stpProvider
 
Methods inherited from interface javax.wvcm.Resource
doCopy, doFind, doFindAll, doGetPropertyNameList, doGetPropertyNameList, doReadContent, doReadProperties, doUnbindAll, doWriteContent, doWriteProperties, forgetProperty, getDisplayName, getParentList, getPathnameLocation, getProperty, initProperty, location, lookupProperty, modifyLocation, propertyNameList, provider, removeProperty, setDisplayName, setProperty, setProperty, updatedPropertyNameList
 
Methods inherited from interface javax.wvcm.Folder
doBindChild, doReadMemberList, doRebindAll, doRebindChild, doUnbindChild, getChildList, getChildMap
 

Field Detail

ATTACHMENT_LIST

static final PropertyNameList.PropertyName<ResourceList<CqAttachment>> ATTACHMENT_LIST
The members of this folder. The attachments that are associated with this folder's parent record field. A more-strongly-typed version of the the Folder.CHILD_LIST property.


FIELD

static final PropertyNameList.PropertyName<CqFieldValue<CqAttachmentFolder>> FIELD
The record field that contains this attachment folder as its value.


RECORD

static final PropertyNameList.PropertyName<CqRecord> RECORD
The parent record of this folder.


RECORD_TYPE

static final PropertyNameList.PropertyName<CqRecordType> RECORD_TYPE
A CqRecordType proxy for the record-type resource that defines the parent record of this attachment folder.

Method Detail

getAttachmentList

ResourceList<CqAttachment> getAttachmentList()
                                             throws WvcmException
Returns the value of the ATTACHMENT_LIST property as defined by this proxy.

Returns:
A List of CqAttachment proxies for the attachments in this attachment folder.
Throws:
WvcmException - if this proxy does not define a value for the ATTACHMENT_LIST property.

getField

CqFieldValue<?> getField()
                         throws WvcmException
Returns the value of the FIELD property as defined by this proxy.

Returns:
A CqFieldValue structure for the field that references this folder. Will never be null.
Throws:
WvcmException - if this proxy does not define a value for the FIELD property.

getRecord

CqRecord getRecord()
                   throws WvcmException
Returns the value of the RECORD property as defined by this proxy.

Returns:
A Record proxy for the record with which this folder is associated.
Throws:
WvcmException - if this Property instance does not define a value for the RECORD metadata component.

getRecordType

CqRecordType getRecordType()
                           throws WvcmException
A CqRecordType proxy for the record-type resource that defines what kind of record this is.

Returns:
The proxy for the record-type of this record is returned.
Throws:
WvcmException - if this proxy does not define a value for the RECORD_TYPE property.

Generated Sun 26-Oct-2008 10:17 AM

Copyright © IBM 2008. All rights reserved.