Package de.elo.ix.client

Class DeleteOptions

java.lang.Object
byps.BValueClass
de.elo.ix.client.ValueClass
de.elo.ix.client.DeleteOptions
All Implemented Interfaces:
Serializable
public class DeleteOptions extends ValueClass implements Serializable
This class contains options for deleting archive entries using the IXServicePortIF.deleteSord(ClientInfo, String, String, LockZ, DeleteOptions) function.
See Also:

  • Field Details

    • deleteFinally

      protected boolean deleteFinally
      deleteFinally=true causes the objects to be removed physically. When used together with cleanupStart, this option is always true. Exception: see deleteExpiredOnly

    • maxIDate

      protected String maxIDate
      maxIDate ist the ISO representation of the local date used to mark the upper limit for deleting.

    • deleteExpiredOnly

      protected boolean deleteExpiredOnly
      Delete only expired objects. Only supported in function IXServicePortIF.cleanupStart(ClientInfo, DeleteOptions). This option can be combined with deleteFinally.
      Behavior
      deleteFinally Action
      false All expired objects will be marked as deleted (but not finally deleted). The objects ACL is checked before it is deleted. LockC.FORCE is applied when deleting an object.
      true Objects that are expired and marked are deleted finally.
      Since:
      6.00.098

    • maxTStamp

      protected String maxTStamp
      Delete objects modified last time before this date. Only supported in function cleanupStart. If deleteFinally is true and this member is set, ony those objects are deleted finally, which were deleted logically before the given time. It must be an ISO value in the local time zone.
      Since:
      7.00.000.041

    • deleteDocumentVersionsOnly

      protected boolean deleteDocumentVersionsOnly
      Delete the document versions of the objects but keep keywording information. In order to delete only the document versions, call deleteSord on an maybe undeleted object and set DeleteOptions.deleteFinally=true and DeleteOptions.deleteDocumentVersionsOnly=true.
      Since:
      7.00.000.044

    • deleteCertainDocumentVersionsOnly

      protected boolean deleteCertainDocumentVersionsOnly
      Delete physically certain document versions of the objects. In order to delete physically certain document versions, first mark document versions as deleted (using DocVersion.setDeleted, followed by checkinDocEnd). Then call deleteSord after having set DeleteOptions.deleteFinally=true and DeleteOptions.deleteCertainDocumentVersionsOnly=true. (In order to delete all document versions, use field deleteDocumentVersionsOnly)
      Since:
      8.00.030.002

    • deleteResidueFree

      protected boolean deleteResidueFree
      Delete all references to the objects in the database. This includes reporting, replication control information, fulltext, etc. This option is ignroed, if deleteFinally is false.
      Since:
      7.00.000.044

    • folderMustBeEmpty

      protected boolean folderMustBeEmpty
      Delete a folder only if it is empty. Set this member to true, if deleteSord should delete only empty folders. If the parameters to deleteSord specify the original location of a non-empty folder, the exception IXExceptionC.ACCESS_DENIED is thrown. This option is ignored, if deleteSord is invokded with a reference.
      Since:
      8.00.010.003

    • deleteExpiredFolders

      protected boolean deleteExpiredFolders
      Delete only expired folders and documents. Only expired empty folders can be deleted. Only supported in function IXServicePortIF.cleanupStart(ClientInfo, DeleteOptions). This option can be combined with deleteFinally.
      Behavior
      deleteFinally Action
      false All expired objects will be marked as deleted (but not finally deleted). The objects ACL is checked before it is deleted. LockC.FORCE is applied when deleting an object.
      true Objects that are expired and marked are deleted finally.
      Since:
      8.00.032.009

  • Constructor Details

    • DeleteOptions

      public DeleteOptions()

    • DeleteOptions

      public DeleteOptions(DeleteOptions rhs)

  • Method Details

    • isDeleteFinally

      public boolean isDeleteFinally()

    • setDeleteFinally

      public void setDeleteFinally(boolean deleteFinally)

    • getMaxIDate

      public String getMaxIDate()

    • setMaxIDate

      public void setMaxIDate(String maxIDate)

    • isDeleteExpiredOnly

      public boolean isDeleteExpiredOnly()

    • setDeleteExpiredOnly

      public void setDeleteExpiredOnly(boolean deleteExpiredOnly)

    • getMaxTStamp

      public String getMaxTStamp()

    • setMaxTStamp

      public void setMaxTStamp(String maxTStamp)

    • isDeleteDocumentVersionsOnly

      public boolean isDeleteDocumentVersionsOnly()

    • setDeleteDocumentVersionsOnly

      public void setDeleteDocumentVersionsOnly(boolean deleteDocumentVersionsOnly)

    • isDeleteCertainDocumentVersionsOnly

      public boolean isDeleteCertainDocumentVersionsOnly()

    • setDeleteCertainDocumentVersionsOnly

      public void setDeleteCertainDocumentVersionsOnly(boolean deleteCertainDocumentVersionsOnly)

    • isDeleteResidueFree

      public boolean isDeleteResidueFree()

    • setDeleteResidueFree

      public void setDeleteResidueFree(boolean deleteResidueFree)

    • isFolderMustBeEmpty

      public boolean isFolderMustBeEmpty()

    • setFolderMustBeEmpty

      public void setFolderMustBeEmpty(boolean folderMustBeEmpty)

    • isDeleteExpiredFolders

      public boolean isDeleteExpiredFolders()

    • setDeleteExpiredFolders

      public void setDeleteExpiredFolders(boolean deleteExpiredFolders)

    • toString

      public String toString()
      Overrides:
      toString in class Object