Package de.elo.ix.client

Class Sord

java.lang.Object
byps.BValueClass
de.elo.ix.client.ValueClass
de.elo.ix.client.Sord
All Implemented Interfaces:
java.io.Serializable
public class Sord
extends ValueClass
implements java.io.Serializable

Indexing information of an archive entry.

Copyright: Copyright (c) 2004

Organisation: ELO Digital Office GmbH

See Also:
Serialized Form

  • Field Details

    • SReg

      protected java.lang.String SReg
      Version numer of the current work version.

    • TStamp

      protected java.lang.String TStamp
      Timestamp of the last change. The format is JJJJ.MM.DD.hh.mm.ss

    • acl

      protected java.lang.String acl
      Access control language in coded form. The checkInSord method must set either acl or aclItems. aclItems has priority.

    • att

      protected int att
      Id of the current attachment version. Read-only.

    • childCount

      protected int childCount
      Estimated sum of the sub-entries in a directory. This does not take account of any access rights assigned to the entries. This property should only be used to determine whether the directory has additional entries. Read-only.

    • doc

      protected int doc
      Read-only. Id of the current document version.

    • guid

      protected java.lang.String guid
      GUID of the current document version.

    • histCount

      protected int histCount
      Number of document versions.

    • id

      protected int id
      Id of the current document version.

    • info

      protected int info
      RESERVED

    • key

      protected int key
      RESERVED

    • kind

      protected int kind
      Colour

    • lockId

      protected int lockId
      This is the id of the user who has a lock on the object. To know whether the Sord or the Document is locked, see lockIdSord or lockIdDoc respectively. The object is locked using checkoutSord with the LOCK.YES, LOCK.SORD or LOCK.DOC parameter. Read-only.

    • mask

      protected int mask
      The id of the filing mask used to archive the sord. Read-only.

    • name

      protected java.lang.String name
      The short description/name for the object.

    • ownerId

      protected int ownerId
      The id of the owner of the object. Main-administrators can assign an owner ID for new Sords in IXServicePortIF.checkinSord(ClientInfo, Sord, SordZ, LockZ) and IXServicePortIF.checkinSordPath(ClientInfo, String, Sord[], SordZ). This member is read-only for Non-adminstrators or existing Sords.

    • parentId

      protected int parentId
      Id of the parent object(archive heirachy) of the sord object. Read-only

    • path

      protected int path
      Filing path for the document manager. Only valid for documents. Read-only.

      If this Sord object is obtained by a call to checkoutSord or checkoutDoc with a database lock (e.g. LockC.IF_FREE), this member contains the storage path specified in the associated keywording form (DocMask.DPath). If the keywording form does not define a path, the default storage path is returned (ServerInfoDM.basisStoreIds[0]). Hence, the current value of the database column objekte.objpath is not used as default for new versions anymore.

      If this Sord object is obtained by a call without a lock, e.g. from findFirstSords, this value should not be used anymore. The storage path of the work version should be used instead, which can be found in Sord.docVersion.pathId.

      See Also:
      DocMask.DPath, ServerInfoDM.basisStoreIds

    • type

      protected int type
      The type of sord object. Folder objects: 0 < type < LBT_DOCUMENT Document objects: LBT_DOCUMENT <= type < LBT_DOCUMENT_MAX
      See Also:
      SordC.LBT_DOCUMENT, SordC.LBT_DOCUMENT_MAX

    • vtRep

      protected int vtRep
      RESERVED

    • IDateIso

      protected java.lang.String IDateIso
      ISO encoded internal (archive defined) date.

    • XDateIso

      protected java.lang.String XDateIso
      ISO encoded external (user defined) date.

    • access

      protected int access
      The current users access rights for this Sord. Returns a combination of AccessC.LUR_ constants. Read-only. Is returned when SordC.mbAcl is set in checkoutSord.

    • aclItems

      protected AclItem[] aclItems
      This is the access control list as an array of AclItem objects.
      See Also:
      acl, AclItem

    • delDateIso

      protected java.lang.String delDateIso
      ISO encoded expiry date. Only users having right AccessC.FLAG_EDITDUEDATE are allowed to set the expiry date. Once the expiry date is set, it cannot be set to a date before the original expiry date.

    • deleted

      protected boolean deleted
      Indicates whether the sord has been deleted or not.

    • desc

      protected java.lang.String desc
      The (visible) memo text. If the value starts with a "!" this member can define a dynamic folder. This is a folder which contents are filled by an arbitrary SQL statement.

    • details

      protected SordDetails details
      Object encapsulates flags.

    • docVersion

      protected DocVersion docVersion
      Version information of current document work version. Read-only.

    • hiddenText

      protected java.lang.String hiddenText
      Hidden text that must not be displayed to the user.

    • linksComeIn

      protected SordLink[] linksComeIn
      Links pointing from other archive entries to this. Read-only.

    • linksGoOut

      protected SordLink[] linksGoOut
      Links starting from this to other archive entries. Read-only.
      See Also:
      IXServicePortIF.linkSords(...)

    • lockName

      protected java.lang.String lockName
      The name of the user who has locked the object. Read-only.
      See Also:
      lockId

    • objKeys

      protected ObjKey[] objKeys
      Index values. This array is only valid, if the associated keywording form DocMask is organized as DocMask.dataOrganisation = DocMaskC.DATA_ORGANISATION_OBJKEYS or DocMaskC.DATA_ORGANISATION_TABLE.
      See Also:
      aspects

    • ownerName

      protected java.lang.String ownerName
      Name of the owner (read-only).

    • parentIds

      protected java.lang.String[] parentIds
      GUIDs of archive entries that contain a reference to this. The first element of the array is the GUID of the main parent, where this is physically placed. Read-only.
      See Also:
      IXServicePortIF.linkSords(...)

    • refPaths

      protected ArcPath[] refPaths
      Archive paths to this Sord. The first path, refPaths[0], contains the path to the original Sord. The other paths contain references to this Sord. The paths do not include an entry for the archive and for this Sord. Since 10.18.021, TTS005149: If the user does not have read access to at least one element in a reference path, this path is excluded from the list. An exception applies to the original path. If the user does not have read access to at least one element in the original path, the ArcPath object at refPaths[0] is empty: refPaths[0].path.length == 0, refPaths[0].pathAsString = "ΒΆ". In contrast to refPaths, the array parentIds is not checked for read access.

    • replNames

      protected ReplSetName[] replNames
      Replication set names. The replication set information of an object is binary encoded in the database. The Class ReplNameMap provides functions to convert from the binary format into a list of replication set names and vice versa. Both replNames and replSet contain the information in which replications set the object is contain in. replNames has priority when checking the object in.
      See Also:
      ReplSetName

    • replSet

      protected ReplSet replSet
      Replication sets. Binary encoded information. Both replNames and replSet contain the information determining in which replications sets the object is contain in. replNames has priority when checking the object in.
      See Also:
      ReplSet

    • maskName

      protected java.lang.String maskName
      Name of keywording form. This value is translated into the language given by ClientInfo.language. It cannot be used as a parameter in Indexserver API functions. Use getMask() to specify the Keywording form in API functions. Read-only.
      Since:
      7.00.000.028
      See Also:
      mask

    • attVersion

      protected DocVersion attVersion
      Work version of the attachment.
      Since:
      7.00.040.007

    • deleteDateIso

      protected java.lang.String deleteDateIso
      The Sord is deleted at this date. ClientInfo determines the Timezone.

      Is undefined if isDeleted() returns false.

      Since:
      9.00.000.000

    • lockIdSord

      protected int lockIdSord
      This is the id of the user who has a lock on the object (not the document). The object is locked using checkoutSord with the LOCK.SORD parameter. Read-only.
      Since:
      9.99.009.001

    • lockIdDoc

      protected int lockIdDoc
      This is the id of the user who has a lock on the document (not the object). The object is locked using checkoutSord with the LOCK.DOC parameter. Read-only.
      Since:
      9.99.009.001

    • lockNameSord

      protected java.lang.String lockNameSord
      The name of the user who has locked the object. Read-only.
      Since:
      9.99.009.001

    • lockNameDoc

      protected java.lang.String lockNameDoc
      The name of the user who has locked the document. Read-only.
      Since:
      9.99.009.001

    • TStampSync

      protected java.lang.String TStampSync
      Timestamp of this object's last export by the replication.
      Since:
      9.99.009.001

    • TStampAcl

      protected java.lang.String TStampAcl
      Timestamp of the last ACL change. The format is JJJJ.MM.DD.hh.mm.ss
      Since:
      9.99.009.001

    • TStampAclSync

      protected java.lang.String TStampAclSync
      Timestamp of this object's ACLs last export by the replication.
      Since:
      9.99.009.001

    • deleteUser

      protected int deleteUser
      The Sord is deleted at this user.

      Is undefined if isDeleted() returns false.

      Since:
      10.00.020.012

    • aspects

      protected java.util.Map<java.lang.String,​java.util.List<java.util.Map<java.lang.String,​IndexValue>>> aspects
      Index values. This member is only valid, if the associated keywording form DocMask is organized as DocMask.dataOrganisation = DocMaskC.DATA_ORGANISATION_ASPECT.
      The outer key is the name of an AspectAssoc. The value is a list of maps.
      This list can contain more than one element according to cardinality of the aspect association.
      The inner maps are aspect objects, i.e. maps from lineKey of the corresponding aspect to an object of class IndexValue which holds the actual data for an aspect line.
      Since:
      20.00.000.100

    • regionId

      protected int regionId
      If the sord is contained in a region (i.e. lies below an object in archive tree that has an associated keywording form which defines a region), this value contains the numeric Id of that region sord. This value is only valid, if the associated keywording form DocMask is organized as DocMask.dataOrganisation = DocMaskC.DATA_ORGANISATION_ASPECT.
      Since:
      20.00.000.100

  • Constructor Details

    • Sord

      public Sord()

    • Sord

      public Sord​(long changedMembers, java.lang.String SReg, java.lang.String TStamp, java.lang.String acl, int att, int childCount, int doc, java.lang.String guid, int histCount, int id, int info, int key, int kind, int lockId, int mask, java.lang.String name, int ownerId, int parentId, int path, int type, int vtRep, java.lang.String IDateIso, java.lang.String XDateIso, int access, AclItem[] aclItems, java.lang.String delDateIso, boolean deleted, java.lang.String desc, SordDetails details, DocVersion docVersion, java.lang.String hiddenText, SordLink[] linksComeIn, SordLink[] linksGoOut, java.lang.String lockName, ObjKey[] objKeys, java.lang.String ownerName, java.lang.String[] parentIds, ArcPath[] refPaths, ReplSetName[] replNames, ReplSet replSet)

    • Sord

      public Sord​(Sord rhs)

  • Method Details