Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## oracle.ifs.fdk.core
Class CoreArchiveManager

    java.lang.Object
      oracle.ifs.fdk.impl.ArchiveManagerImpl
          oracle.ifs.fdk.core.CoreArchiveManager

All Implemented Interfaces:
  java.rmi.Remote, ArchiveManager

    public class CoreArchiveManager

extends ArchiveManagerImpl

Archive Manager facade implementation

Constructor Summary
`CoreArchiveManager()` Construct a CoreArchiveManager, for WebServices.
`CoreArchiveManager(FdkSession session)` Construct a CoreArchiveManager, for In-process clients.

Method Summary
`void` | `emptyArchive(long archiveId)` Empties a given Archive.
`protected FdkSessionImpl` | `getConnectedSession()` Return the web service session.
`protected boolean` | `isWebServiceCall()` Returns `true` if the current call was made from a web services client.
`protected NamedValue[]` | `login(FdkCredential c, NamedValue[] options, AttributeRequest[] userAttributes)` Internal login method used by web services login managers.
`void` | `referenceTypes(TypeReference ref)` Dummy web service method to create a reference to data types used in the web services to insure that they are defined in the WSDL.
`Item` | `restoreFromArchive(long archiveId, long sourceId, NamedValue[] options)` Restores a document/folder specified by sourceId into the location specified by DESTFOLDER option value from the Archive.
`void` | `setArchiveConfiguration(long archiveId, NamedValue[] attributes)` Updates the specified Archive.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

### CoreArchiveManager

    public CoreArchiveManager()

  Construct a CoreArchiveManager, for WebServices.

### CoreArchiveManager

    public CoreArchiveManager(FdkSession session)

  Construct a CoreArchiveManager, for In-process clients.

  Parameters:
    `session` - The session context

Method Detail

### emptyArchive

    public void emptyArchive(long archiveId)
                      throws FdkException

  Description copied from class: `CoreArchiveManager`
  Empties a given Archive.

  Parameters:
    `archiveId` - The Id of archive to be emptied
  Throws:
    `FdkException` - If the operation fails

### setArchiveConfiguration

    public void setArchiveConfiguration(long archiveId,
                                        NamedValue[] attributes)
                                 throws FdkException

  Description copied from class: `CoreArchiveManager`
  Updates the specified Archive.

  Parameters:
    `archiveId` - the Archive for which to set the configuration
    `attributes` - the Archive configuration options to set; must include one or more of the following Attributes:
    - notation: {Attribute name, Attribute type}
    - {Attributes.ARCHIVE_ENABLED, Boolean}
    - {Attributes.ARCHIVE_AUTO_EMPTY_ENABLED, Boolean}
    - {Attributes.ARCHIVE_MIN_HOLDING_PERIOD, Long}
  Throws:
    `FdkException` - if the operation fails.

### restoreFromArchive

    public Item restoreFromArchive(long archiveId,
                                   long sourceId,
                                   NamedValue[] options)
                            throws FdkException

  Description copied from class: `CoreArchiveManager`
  Restores a document/folder specified by sourceId into the location specified by DESTFOLDER option value from the Archive.

  Parameters:
    `archiveId` - The Archive
    `sourceId` - The document to be restored
    `options` - The attributes for restore ,such as destination folder
    - notation: {Attribute name, Attribute type}
    - {Attributes.NAME, String}
    - {Options.DESTFOLDER, Long}
    - {Options.OVERWRITE, Boolean}
    - {Options.UNIQUENAME, Boolean}
    - {Options.NEWVERSION, Boolean}
    - {Options.RESPECT_NULL_RESOURCE_LOCKS, Boolean}
  Returns:
    The restored item
  Throws:
    `FdkException` - If the operation fails

### isWebServiceCall

    protected final boolean isWebServiceCall()

  Returns `true` if the current call was made from a web services client. This check can be made by any subclasses in order to determine functionality and restrictions based on the originating call. This feature should be used lightly and only where really necessary as this is not an idea way of implementing business logic.

### referenceTypes

    public void referenceTypes(TypeReference ref)

  Dummy web service method to create a reference to data types used in the web services to insure that they are defined in the WSDL.

### login

    protected final NamedValue[] login(FdkCredential c,
                                       NamedValue[] options,
                                       AttributeRequest[] userAttributes)
                                throws FdkException

  Internal login method used by web services login managers.

  Throws:
    `FdkException`

### getConnectedSession

    protected final FdkSessionImpl getConnectedSession()
                                                throws FdkException

  Return the web service session. The return value is guaranteed to be non-null and to represent a connected session. If the client is not authenticated an FdkException is thrown.

  Throws:
    `FdkException`

Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD