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:
Serializable
public class Sord extends ValueClass implements Serializable

Indexing information of an archive entry.

Copyright: Copyright (c) 2004

Organisation: ELO Digital Office GmbH

See Also:

  • Field Details

    • SReg

      protected String SReg
      Version numer of the current work version.

    • TStamp

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

    • acl

      protected 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 String guid
      GUID.

    • histCount

      protected int histCount
      Number of document versions.

    • id

      protected int id
      Numeric ID.

    • 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 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:

    • 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:

    • vtRep

      protected int vtRep
      RESERVED

    • IDateIso

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

    • XDateIso

      protected 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:

    • delDateIso

      protected 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 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 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:

    • lockName

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

    • 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:

    • ownerName

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

    • parentIds

      protected 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:

    • 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:

    • 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:

    • maskName

      protected 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:

    • attVersion

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

    • deleteDateIso

      protected 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 String lockNameSord
      The name of the user who has locked the object. Read-only.
      Since:
      9.99.009.001

    • lockNameDoc

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

    • TStampSync

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

    • TStampAcl

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

    • TStampAclSync

      protected 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 Map<String,List<Map<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

    • spaceGuid

      protected String spaceGuid
      If the sord belongs to a workspace, this value contains the GUID of that workspace.
      Since:
      21.00.000.003

    • spaceGuids

      protected List<String> spaceGuids
      If the sord belongs to a workspace, this value contains the GUIDs of parent workspaces.
      Since:
      21.00.000.021

    • TStampLocal

      protected String TStampLocal
      Timestamp that indicates the next iSearch Index run The format is JJJJ.MM.DD.hh.mm.ss
      Since:
      21.02.000.004

    • packageName

      protected String packageName
      Package name of sord
      Since:
      21.03.000.013

    • regionId

      protected int regionId
      This is a RESERVED field for future use. Do not use.
      The region id of a sord.
      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. Thus, this field defines the membership of this sord object to the region specified by this value.

      Although the sord defining the region is always associated to a keywording form DocMask which is organized as DocMaskC.DATA_ORGANISATION_ASPECT, this sord belonging to a region can be of any type of data organisation (objkey, table or aspect).
      Since:
      20.00.000.100

  • Constructor Details

  • Method Details

    • getSReg

      public String getSReg()

    • setSReg

      public void setSReg(String SReg)

    • getTStamp

      public String getTStamp()

    • setTStamp

      public void setTStamp(String TStamp)

    • getAcl

      public String getAcl()

    • setAcl

      public void setAcl(String acl)

    • getAtt

      public int getAtt()

    • setAtt

      public void setAtt(int att)

    • getChildCount

      public int getChildCount()

    • setChildCount

      public void setChildCount(int childCount)

    • getDoc

      public int getDoc()

    • setDoc

      public void setDoc(int doc)

    • getGuid

      public String getGuid()

    • setGuid

      public void setGuid(String guid)

    • getHistCount

      public int getHistCount()

    • setHistCount

      public void setHistCount(int histCount)

    • getId

      public int getId()

    • setId

      public void setId(int id)

    • getInfo

      public int getInfo()

    • setInfo

      public void setInfo(int info)

    • getKey

      public int getKey()

    • setKey

      public void setKey(int key)

    • getKind

      public int getKind()

    • setKind

      public void setKind(int kind)

    • getLockId

      public int getLockId()

    • setLockId

      public void setLockId(int lockId)

    • getMask

      public int getMask()

    • setMask

      public void setMask(int mask)

    • getName

      public String getName()

    • setName

      public void setName(String name)

    • getOwnerId

      public int getOwnerId()

    • setOwnerId

      public void setOwnerId(int ownerId)

    • getParentId

      public int getParentId()

    • setParentId

      public void setParentId(int parentId)

    • getPath

      public int getPath()

    • setPath

      public void setPath(int path)

    • getType

      public int getType()

    • setType

      public void setType(int type)

    • getVtRep

      public int getVtRep()

    • setVtRep

      public void setVtRep(int vtRep)

    • getIDateIso

      public String getIDateIso()

    • setIDateIso

      public void setIDateIso(String IDateIso)

    • getXDateIso

      public String getXDateIso()

    • setXDateIso

      public void setXDateIso(String XDateIso)

    • getAccess

      public int getAccess()

    • setAccess

      public void setAccess(int access)

    • getAclItems

      public AclItem[] getAclItems()

    • setAclItems

      public void setAclItems(AclItem[] aclItems)

    • getDelDateIso

      public String getDelDateIso()

    • setDelDateIso

      public void setDelDateIso(String delDateIso)

    • isDeleted

      public boolean isDeleted()

    • setDeleted

      public void setDeleted(boolean deleted)

    • getDesc

      public String getDesc()

    • setDesc

      public void setDesc(String desc)

    • getDetails

      public SordDetails getDetails()

    • setDetails

      public void setDetails(SordDetails details)

    • getDocVersion

      public DocVersion getDocVersion()

    • setDocVersion

      public void setDocVersion(DocVersion docVersion)

    • getAttVersion

      public DocVersion getAttVersion()

    • setAttVersion

      public void setAttVersion(DocVersion attVersion)

    • getHiddenText

      public String getHiddenText()

    • setHiddenText

      public void setHiddenText(String hiddenText)

    • getLinksComeIn

      public SordLink[] getLinksComeIn()

    • setLinksComeIn

      public void setLinksComeIn(SordLink[] linksComeIn)

    • getLinksGoOut

      public SordLink[] getLinksGoOut()

    • setLinksGoOut

      public void setLinksGoOut(SordLink[] linksGoOut)

    • getLockName

      public String getLockName()

    • setLockName

      public void setLockName(String lockName)

    • getObjKeys

      public ObjKey[] getObjKeys()

    • setObjKeys

      public void setObjKeys(ObjKey[] objKeys)

    • getOwnerName

      public String getOwnerName()

    • setOwnerName

      public void setOwnerName(String ownerName)

    • getParentIds

      public String[] getParentIds()

    • setParentIds

      public void setParentIds(String[] parentIds)

    • getRefPaths

      public ArcPath[] getRefPaths()

    • getRefPathsDirect

      public ArcPath[] getRefPathsDirect()

    • setRefPaths

      public void setRefPaths(ArcPath[] refPaths)

    • getReplNames

      public ReplSetName[] getReplNames()

    • setReplNames

      public void setReplNames(ReplSetName[] replNames)

    • getReplSet

      public ReplSet getReplSet()

    • setReplSet

      public void setReplSet(ReplSet replSet)

    • getMaskName

      public String getMaskName()

    • setMaskName

      public void setMaskName(String v)

    • getDeleteDateIso

      public String getDeleteDateIso()

    • setDeleteDateIso

      public void setDeleteDateIso(String deleteDateIso)

    • getDeleteUser

      public int getDeleteUser()

    • setDeleteUser

      public void setDeleteUser(int deleteUser)

    • getLockIdSord

      public int getLockIdSord()

    • setLockIdSord

      public void setLockIdSord(int lockIdSord)

    • getLockIdDoc

      public int getLockIdDoc()

    • setLockIdDoc

      public void setLockIdDoc(int lockIdDoc)

    • getLockNameSord

      public String getLockNameSord()

    • setLockNameSord

      public void setLockNameSord(String lockNameSord)

    • getLockNameDoc

      public String getLockNameDoc()

    • setLockNameDoc

      public void setLockNameDoc(String lockNameDoc)

    • getTStampAcl

      public String getTStampAcl()

    • setTStampAcl

      public void setTStampAcl(String tStampAcl)

    • getTStampAclSync

      public String getTStampAclSync()

    • setTStampAclSync

      public void setTStampAclSync(String tStampAclSync)

    • getTStampSync

      public String getTStampSync()

    • setTStampSync

      public void setTStampSync(String tStampSync)

    • getAspects

      public Map<String,List<Map<String,IndexValue>>> getAspects()

    • setAspects

      public void setAspects(Map<String,List<Map<String,IndexValue>>> aspects)

    • getRegionId

      public int getRegionId()

    • setRegionId

      public void setRegionId(int regionId)

    • getSpaceGuid

      public String getSpaceGuid()

    • setSpaceGuid

      public void setSpaceGuid(String spaceGuid)

    • getSpaceGuids

      public List<String> getSpaceGuids()

    • setSpaceGuids

      public void setSpaceGuids(List<String> spaceGuids)

    • getPackageName

      public String getPackageName()

    • setPackageName

      public void setPackageName(String packageName)

    • getTStampLocal

      public String getTStampLocal()

    • setTStampLocal

      public void setTStampLocal(String tStampLocal)

    • isNew

      public boolean isNew()

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object