Package com.documentum.fc.client

Interface IDfLocation

All Superinterfaces:

IDfPersistentObject, IDfSysObject, IDfTypedObject

public interface IDfLocation
extends IDfSysObject

This interface provides access to location properties. This class validates that the required properties name and link location are set before saving. Otherwise, an exception is thrown.

Field Summary

Fields inherited from interface com.documentum.fc.client.IDfPersistentObject

CURRENCY_CHECK_ALWAYS, CURRENCY_CHECK_FIRST_ACCESS, CURRENCY_CHECK_NEVER, CURRENCY_CHECK_ONCE_PER_SCOPE

Method Summary

Modifier and Type	Method	Description
String	getFileSystemPath()	Gets the file system path of this location.
String	getMountPointName()	Gets the mount point name of this location.
int	getPathType()	Gets the path type of this location.
int	getSecurityType()	Gets the security type of this location.
boolean	isValidate()	Determines whether this location validates.
void	setFileSystemPath(String fileSystemPath)	Sets the file system path of this location.
void	setMountPointName(String mountPointName)	Sets the mount point name of this location.
void	setNewMountPoint(String path)	Sets the mount point of this location by passing the file system path of the mount point.
void	setPathType(int pathType)	Sets the path type of this location.
void	setSecurityType(int securityType)	Sets the security type of this location.
void	setValidate(boolean validate)	Sets whether this location should validate

Methods inherited from interface com.documentum.fc.client.IDfPersistentObject

addChildRelative, addParentRelative, apiExec, apiGet, apiSet, destroy, fetch, fetchWithCaching, getAttrAssistance, getAttrAssistanceWithValues, getAttrAsstDependencies, getChildRelatives, getParentRelatives, getPartition, getType, getValidator, getVStamp, getWidgetType, isDeleted, isDirty, isInstanceOf, isNew, isReplica, lock, lockEx, registerEvent, removeChildRelative, removeParentRelative, revert, save, setPartition, signoff, unRegisterEvent, unRegisterEventEx, validateAllRules, validateAttrRules, validateAttrRulesWithValue, validateAttrRulesWithValues, validateObjRules, validateObjRulesWithValues

Methods inherited from interface com.documentum.fc.client.IDfSysObject

addDigitalSignature, addESignature, addNote, addReference, addRendition, addRenditionEx, addRenditionEx2, addRenditionEx3, appendContent, appendContentEx, appendFile, appendFileEx, appendPart, areAttributesModifiable, assemble, asVirtualDocument, attachPolicy, bindFile, branch, cancelCheckout, cancelCheckoutEx, cancelScheduledDemote, cancelScheduledPromote, cancelScheduledResume, cancelScheduledSuspend, canDemote, canPromote, canResume, canSuspend, checkin, checkinEx, checkout, checkoutEx, demote, destroyAllVersions, detachPolicy, disassemble, freeze, getAccessDate, getAccessorApplicationPermit, getAccessorCount, getAccessorName, getAccessorPermit, getAccessorPermitType, getAccessorXPermit, getAccessorXPermitNames, getACL, getACLDomain, getACLName, getAclRefValid, getAcsRequests, getAliasSet, getAliasSetId, getAntecedentId, getApplicationType, getAssembledFromId, getAuthors, getAuthorsCount, getBranchCount, getCabinetId, getChronicleId, getCollectionForContent, getCollectionForContentEx2, getCollectionForContentEx3, getCollectionForContentEx4, getComponentId, getComponentIdCount, getCompoundArchitecture, getContainId, getContainIdCount, getContent, getContentAvailability, getContentEx, getContentEx2, getContentEx3, getContentsId, getContentSize, getContentSize, getContentState, getContentStateCount, getContentType, getCreationDate, getCreatorName, getCurrentState, getCurrentStateName, getDirectDescendant, getDoubleContentAttr, getExceptionStateName, getFile, getFileEx, getFileEx2, getFolderId, getFolderIdCount, getFormat, getFrozenAssemblyCount, getFullText, getGroupName, getGroupPermit, getHasEvents, getHasFolder, getHasFrozenAssembly, getImplicitVersionLabel, getKeywords, getKeywordsCount, getLatestFlag, getLinkCount, getLinkHighCount, getLocations, getLockDate, getLockMachine, getLockOwner, getLogEntry, getMasterDocbase, getModifier, getModifyDate, getNextStateName, getObjectName, getOtherFileSize, getOwnerName, getOwnerPermit, getPageCount, getPath, getPathEx, getPathEx2, getPermissions, getPermit, getPermitEx, getPolicyId, getPolicyName, getPreviousStateName, getReferenceCount, getRemoteId, getRenditions, getResolutionLabel, getResumeState, getResumeStateName, getRetainerCount, getRetainerId, getRetainUntilDate, getRetentionDate, getRouters, getSpecialApp, getStatus, getStorageType, getStringContentAttr, getSubject, getTimeContentAttr, getTitle, getTypeName, getVdmPath, getVdmPathDQL, getVersionLabel, getVersionLabelCount, getVersionLabels, getVersionPolicy, getVersions, getWorkflows, getWorldPermit, getXPermit, getXPermitList, getXPermitNames, grant, grantPermit, hasPermission, insertContent, insertContentEx, insertFile, insertFileEx, insertPart, isArchived, isCheckedOut, isCheckedOutBy, isContentTransferCapabilityEnabled, isFrozen, isHidden, isImmutable, isLinkResolved, isPublic, isReference, isSuspended, isVirtualDocument, link, mark, mount, print, promote, prune, queue, refreshReference, removeContent, removeNote, removePart, removeRendition, removeRenditionEx, removeRenditionEx2, resolveAlias, resume, revertACL, revoke, revokePermit, saveAsNew, saveLock, scheduleDemote, schedulePromote, scheduleResume, scheduleSuspend, setACL, setACLDomain, setACLName, setApplicationType, setArchived, setAuthors, setCompoundArchitecture, setContent, setContentEx, setContentEx2, setContentType, setDoubleContentAttribute, setFile, setFileEx, setFullText, setGroupName, setGroupPermit, setHidden, setIsVirtualDocument, setKeywords, setLinkResolved, setLogEntry, setObjectName, setOwnerName, setOwnerPermit, setPath, setResolutionLabel, setSpecialApp, setStatus, setStorageType, setStringContentAttribute, setSubject, setTimeContentAttribute, setTitle, setWorldPermit, suspend, unfreeze, unlink, unmark, updatePart, updatePartEx, useACL, verifyESignature

Methods inherited from interface com.documentum.fc.client.IDfTypedObject

appendBoolean, appendDouble, appendId, appendInt, appendString, appendTime, appendValue, dump, enumAttrs, findAttrIndex, findBoolean, findDouble, findId, findInt, findString, findTime, findValue, getAllRepeatingStrings, getAttr, getAttrCount, getAttrDataType, getBoolean, getDouble, getId, getInt, getLong, getObjectId, getObjectSession, getOriginalSession, getRepeatingBoolean, getRepeatingDouble, getRepeatingId, getRepeatingInt, getRepeatingLong, getRepeatingString, getRepeatingTime, getRepeatingValue, getSession, getSessionManager, getString, getTime, getValue, getValueAt, getValueCount, hasAttr, insertBoolean, insertDouble, insertId, insertInt, insertString, insertTime, insertValue, isAttrRepeating, isNull, remove, removeAll, setBoolean, setDouble, setId, setInt, setNull, setRepeatingBoolean, setRepeatingDouble, setRepeatingId, setRepeatingInt, setRepeatingString, setRepeatingTime, setRepeatingValue, setSessionManager, setString, setTime, setValue, truncate

Method Details

setValidate

void setValidate(boolean validate)
          throws DfException

Sets whether this location should validate

Parameters:

validate - Inidicates this location should validate. If it is true, then no_validation attribute is false, and vice versa.

Throws:

DfException

isValidate

boolean isValidate()
            throws DfException

Determines whether this location validates.

Returns:

true if this location validates, false otherwise.

Throws:

DfException

setPathType

void setPathType(int pathType)
          throws DfException

Sets the path type of this location.

Parameters:

pathType - The path type of this location. The only allowed values are constants defined in DfLocation, DIRECTORY or FILE.

Throws:

DfException

getPathType

int getPathType()
         throws DfException

Gets the path type of this location. If the path type is not set or empty, this method returns NOT_DEFINE.

Returns:

The path type of this location. It is either DIRECTORY or FILE defined in DfLocation.

Throws:

DfException

setFileSystemPath

void setFileSystemPath(String fileSystemPath)
                throws DfException

Sets the file system path of this location.

Parameters:

fileSystemPath - The file system path of this location.

Throws:

DfException

getFileSystemPath

String getFileSystemPath()
                  throws DfException

Gets the file system path of this location.

Returns:

The file system path of this location.

Throws:

DfException

setMountPointName

void setMountPointName(String mountPointName)
                throws DfException

Sets the mount point name of this location.

Parameters:

mountPointName - The mount point name of this location.

Throws:

DfException

setNewMountPoint

void setNewMountPoint(String path)
               throws DfException

Sets the mount point of this location by passing the file system path of the mount point. A new mount point object with a unique name is created when saved. The mount point name is _mountPoint.

Throws:

DfException

getMountPointName

String getMountPointName()
                  throws DfException

Gets the mount point name of this location.

Returns:

The mount point name of this location.

Throws:

DfException

setSecurityType

void setSecurityType(int securityType)
              throws DfException

Sets the security type of this location.

Parameters:

securityType - The security type of this location. The valid values are PUBLIC_OPEN, PUBLIC, and PRIVATE defined in DfLocation.

Throws:

DfException

getSecurityType

int getSecurityType()
             throws DfException

Gets the security type of this location. If the security type is not set or empty, this method returns NOT_DEFINE.

Returns:

The security type of this location.

Throws:

DfException