public interface IDfBocsConfig extends IDfSysObject
Modifier and Type | Interface and Description |
---|---|
static interface |
IDfBocsConfig.ExternalUrlEntry
ExternalUrlEntry interface encapsulates external url.
|
static interface |
IDfBocsConfig.UrlEntry
UrlEntry interface encapsulates base url and protocol.
|
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
DELIVERY_TYPE_PULL |
static java.lang.String |
DELIVERY_TYPE_PUSH |
static java.lang.String |
EXTERNAL_URL_TYPE_WS_PUSH |
CURRENCY_CHECK_ALWAYS, CURRENCY_CHECK_FIRST_ACCESS, CURRENCY_CHECK_NEVER, CURRENCY_CHECK_ONCE_PER_SCOPE
Modifier and Type | Method and Description |
---|---|
void |
addExternalUrlEntry(IDfBocsConfig.ExternalUrlEntry urlEntry)
Adds ExternalUrlEntry object.
|
void |
addUrlEntry(IDfBocsConfig.UrlEntry urlEntry)
Adds UrlEntry object.
|
java.lang.String |
getDeliveryType()
Returns the delivery type
|
IDfList |
getDocbaseNames()
Returns list of the repository names.
|
IDfList |
getExternalUrlEntries()
Returns list of ExternalUrlEntry objects.
|
IDfList |
getNetworkLocationIdentifiers()
Returns list of the BOCS network location identifiers.
|
java.lang.String |
getObjectName()
Returns the BOCS name.
|
java.lang.String |
getServerMajorVersion()
Returns server major version
|
java.lang.String |
getServerMinorVersion()
Returns the server minor version
|
IDfList |
getUrlEntries()
Returns list of UrlEntry objects.
|
boolean |
isAsynchWriteEnabled()
Returns a flag indicating whether asynchronous write is enabled
|
boolean |
isEnabled()
Returns a flag indicating whether BOCS is enabled
|
boolean |
isInclusionList()
Returns a flag indicating whether the list of repositories is an inclusion list.
|
IDfBocsConfig.ExternalUrlEntry |
newExternalUrlEntry(java.lang.String url,
java.lang.String type)
Creates ExternalUrlEntry object.
|
IDfBocsConfig.UrlEntry |
newUrlEntry(java.lang.String url,
java.lang.String protocol)
Creates UrlEntry object.
|
void |
setAsynchWriteEnabled(boolean isEnabled)
Sets a flag indicating whether asynchronous write is enabled.
|
void |
setDeliveryType(java.lang.String deliveryType)
Sets the delivery type
|
void |
setDocbaseNames(IDfList docbaseNames)
Sets the repository names.
|
void |
setEnabled(boolean isEnabled)
Sets a flag indicating whether BOCS is enabled
|
void |
setExternalUrlEntries(IDfList urlEntries)
Replace all ExternalUrlEntry objects.
|
void |
setInclusionList(boolean isInclusionList)
Sets a flag indicating whether the list of repositories is an inclusion list.
|
void |
setNetworkLocationIdentifiers(IDfList networkLocationIdentifiers)
Sets the BOCS network location identifiers.
|
void |
setObjectName(java.lang.String objectName)
Sets the BOCS name.
|
void |
setServerMajorVersion(java.lang.String majorVersion)
Sets server major version
|
void |
setServerMinorVersion(java.lang.String minorVersion)
Sets the server minor version
|
void |
setUrlEntries(IDfList urlEntries)
Replace all UrlEntry objects.
|
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, 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, setOwnerName, setOwnerPermit, setPath, setResolutionLabel, setSpecialApp, setStatus, setStorageType, setStringContentAttribute, setSubject, setTimeContentAttribute, setTitle, setWorldPermit, suspend, unfreeze, unlink, unmark, updatePart, updatePartEx, useACL, verifyESignature
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
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
static final java.lang.String DELIVERY_TYPE_PULL
static final java.lang.String DELIVERY_TYPE_PUSH
static final java.lang.String EXTERNAL_URL_TYPE_WS_PUSH
java.lang.String getObjectName() throws DfException
getObjectName
in interface IDfSysObject
DfException
void setObjectName(java.lang.String objectName) throws DfException
setObjectName
in interface IDfSysObject
objectName
- specifies the name of the BOCS.DfException
- if a server error occurs.boolean isEnabled() throws DfException
DfException
- if a server error occurs.boolean isAsynchWriteEnabled() throws DfException
DfException
- if a server error occurs.void setEnabled(boolean isEnabled) throws DfException
isEnabled
- if true, BOCS is enabled, false otherwiseDfException
- if a server error occurs.void setAsynchWriteEnabled(boolean isEnabled) throws DfException
isEnabled
- if true, asynchronous write is enabled, false otherwiseDfException
- if a server error occurs.IDfList getNetworkLocationIdentifiers() throws DfException
DfException
- if a server error occursvoid setNetworkLocationIdentifiers(IDfList networkLocationIdentifiers) throws DfException
networkLocationIdentifiers
- list of the BOCS network location identifiers.DfException
- if a server error occurs.IDfBocsConfig.UrlEntry newUrlEntry(java.lang.String url, java.lang.String protocol) throws DfException
url
- url.protocol
- protocol.DfException
- if a server error occurs.IDfList getUrlEntries() throws DfException
DfException
- if a server error occurs.void addUrlEntry(IDfBocsConfig.UrlEntry urlEntry) throws DfException
urlEntry
- UrlEntry object to be added.DfException
- if a server error occurs.void setUrlEntries(IDfList urlEntries) throws DfException
urlEntries
- list of UrlEntry objects.DfException
- if a server error occurs.boolean isInclusionList() throws DfException
DfException
- if a server error occursvoid setInclusionList(boolean isInclusionList) throws DfException
isInclusionList
- true, if list of repositories is an inclusion list, false otherwise.DfException
- if a server error occursIDfList getDocbaseNames() throws DfException
DfException
- if a server error occursvoid setDocbaseNames(IDfList docbaseNames) throws DfException
docbaseNames
- list of the repository names.DfException
- if a server error occurs.java.lang.String getDeliveryType() throws DfException
DfException
- if a server error occursvoid setDeliveryType(java.lang.String deliveryType) throws DfException
deliveryType
- delivery typeDfException
- if a server error occursjava.lang.String getServerMajorVersion() throws DfException
DfException
- if a server error occursvoid setServerMajorVersion(java.lang.String majorVersion) throws DfException
majorVersion
- server major versionDfException
- if a server error occursjava.lang.String getServerMinorVersion() throws DfException
DfException
- if a server error occursvoid setServerMinorVersion(java.lang.String minorVersion) throws DfException
minorVersion
- server minor versionDfException
- if a server error occursIDfBocsConfig.ExternalUrlEntry newExternalUrlEntry(java.lang.String url, java.lang.String type) throws DfException
url
- url.type
- type.DfException
- if a server error occurs.IDfList getExternalUrlEntries() throws DfException
DfException
- if a server error occurs.void addExternalUrlEntry(IDfBocsConfig.ExternalUrlEntry urlEntry) throws DfException
urlEntry
- ExternalUrlEntry object to be added.DfException
- if a server error occurs.void setExternalUrlEntries(IDfList urlEntries) throws DfException
urlEntries
- list of ExternalUrlEntry objects.DfException
- if a server error occurs.Copyright 1994-2023 OpenText Corporation. All rights reserved.