Package com.documentum.fc.client.acs

Interface IDfBocsConfig

All Superinterfaces:
IDfPersistentObject, IDfSysObject, IDfTypedObject
public interface IDfBocsConfig extends IDfSysObject
This interface represents BOCS configuration object.

  • Field Details

  • Method Details

    • getObjectName

      String getObjectName() throws DfException
      Returns the BOCS name. BOCS name uniquely identifies BOCS.
      Specified by:
      getObjectName in interface IDfSysObject
      Returns:
      name of the BOCS.
      Throws:
      DfException

    • setObjectName

      void setObjectName(String objectName) throws DfException
      Sets the BOCS name. BOCS name uniquely identifies BOCS.
      Specified by:
      setObjectName in interface IDfSysObject
      Parameters:
      objectName - specifies the name of the BOCS.
      Throws:
      DfException - if a server error occurs.

    • isEnabled

      boolean isEnabled() throws DfException
      Returns a flag indicating whether BOCS is enabled
      Returns:
      true, if BOCS is enabled, false otherwise
      Throws:
      DfException - if a server error occurs.

    • isAsynchWriteEnabled

      boolean isAsynchWriteEnabled() throws DfException
      Returns a flag indicating whether asynchronous write is enabled
      Returns:
      true, if asynchronous write is enabled, false otherwise
      Throws:
      DfException - if a server error occurs.

    • setEnabled

      void setEnabled(boolean isEnabled) throws DfException
      Sets a flag indicating whether BOCS is enabled
      Parameters:
      isEnabled - if true, BOCS is enabled, false otherwise
      Throws:
      DfException - if a server error occurs.

    • setAsynchWriteEnabled

      void setAsynchWriteEnabled(boolean isEnabled) throws DfException
      Sets a flag indicating whether asynchronous write is enabled. This also sets BOCS enabled or disabled depending on a value of isEnabled parameter.
      Parameters:
      isEnabled - if true, asynchronous write is enabled, false otherwise
      Throws:
      DfException - if a server error occurs.

    • getNetworkLocationIdentifiers

      IDfList getNetworkLocationIdentifiers() throws DfException
      Returns list of the BOCS network location identifiers.
      Returns:
      list of the BOCS network location identifiers.
      Throws:
      DfException - if a server error occurs

    • setNetworkLocationIdentifiers

      void setNetworkLocationIdentifiers(IDfList networkLocationIdentifiers) throws DfException
      Sets the BOCS network location identifiers.
      Parameters:
      networkLocationIdentifiers - list of the BOCS network location identifiers.
      Throws:
      DfException - if a server error occurs.

    • newUrlEntry

      IDfBocsConfig.UrlEntry newUrlEntry(String url, String protocol) throws DfException
      Creates UrlEntry object.
      Parameters:
      url - url.
      protocol - protocol.
      Returns:
      UrlEntry object with the given url and port.
      Throws:
      DfException - if a server error occurs.

    • getUrlEntries

      IDfList getUrlEntries() throws DfException
      Returns list of UrlEntry objects.
      Returns:
      list of UrlEntry objects.
      Throws:
      DfException - if a server error occurs.

    • addUrlEntry

      void addUrlEntry(IDfBocsConfig.UrlEntry urlEntry) throws DfException
      Adds UrlEntry object.
      Parameters:
      urlEntry - UrlEntry object to be added.
      Throws:
      DfException - if a server error occurs.

    • setUrlEntries

      void setUrlEntries(IDfList urlEntries) throws DfException
      Replace all UrlEntry objects.
      Parameters:
      urlEntries - list of UrlEntry objects.
      Throws:
      DfException - if a server error occurs.

    • isInclusionList

      boolean isInclusionList() throws DfException
      Returns a flag indicating whether the list of repositories is an inclusion list.
      Returns:
      true, if list of repositories is an inclusion list, false otherwise.
      Throws:
      DfException - if a server error occurs

    • setInclusionList

      void setInclusionList(boolean isInclusionList) throws DfException
      Sets a flag indicating whether the list of repositories is an inclusion list.
      Parameters:
      isInclusionList - true, if list of repositories is an inclusion list, false otherwise.
      Throws:
      DfException - if a server error occurs

    • getDocbaseNames

      IDfList getDocbaseNames() throws DfException
      Returns list of the repository names.
      Returns:
      list of the repository names.
      Throws:
      DfException - if a server error occurs

    • setDocbaseNames

      void setDocbaseNames(IDfList docbaseNames) throws DfException
      Sets the repository names.
      Parameters:
      docbaseNames - list of the repository names.
      Throws:
      DfException - if a server error occurs.

    • getDeliveryType

      String getDeliveryType() throws DfException
      Returns the delivery type
      Returns:
      returns the delivery type
      Throws:
      DfException - if a server error occurs

    • setDeliveryType

      void setDeliveryType(String deliveryType) throws DfException
      Sets the delivery type
      Parameters:
      deliveryType - delivery type
      Throws:
      DfException - if a server error occurs

    • getServerMajorVersion

      String getServerMajorVersion() throws DfException
      Returns server major version
      Returns:
      returns the server major version
      Throws:
      DfException - if a server error occurs

    • setServerMajorVersion

      void setServerMajorVersion(String majorVersion) throws DfException
      Sets server major version
      Parameters:
      majorVersion - server major version
      Throws:
      DfException - if a server error occurs

    • getServerMinorVersion

      String getServerMinorVersion() throws DfException
      Returns the server minor version
      Returns:
      returns the server minor version
      Throws:
      DfException - if a server error occurs

    • setServerMinorVersion

      void setServerMinorVersion(String minorVersion) throws DfException
      Sets the server minor version
      Parameters:
      minorVersion - server minor version
      Throws:
      DfException - if a server error occurs

    • newExternalUrlEntry

      IDfBocsConfig.ExternalUrlEntry newExternalUrlEntry(String url, String type) throws DfException
      Creates ExternalUrlEntry object.
      Parameters:
      url - url.
      type - type.
      Returns:
      ExternalUrlEntry object with the given url and type.
      Throws:
      DfException - if a server error occurs.

    • getExternalUrlEntries

      IDfList getExternalUrlEntries() throws DfException
      Returns list of ExternalUrlEntry objects.
      Returns:
      list of ExternalUrlEntry objects.
      Throws:
      DfException - if a server error occurs.

    • addExternalUrlEntry

      void addExternalUrlEntry(IDfBocsConfig.ExternalUrlEntry urlEntry) throws DfException
      Adds ExternalUrlEntry object.
      Parameters:
      urlEntry - ExternalUrlEntry object to be added.
      Throws:
      DfException - if a server error occurs.

    • setExternalUrlEntries

      void setExternalUrlEntries(IDfList urlEntries) throws DfException
      Replace all ExternalUrlEntry objects.
      Parameters:
      urlEntries - list of ExternalUrlEntry objects.
      Throws:
      DfException - if a server error occurs.