GetDocumentListCategoryCatalog

GetDocumentListCategoryCatalog
Main
 
Rückgabewert
DocumentCategoryCatalog[]
RET
DocumentCategoryCatalog (Struct) Array
 
Parameterliste
NamedValueArray
INo
NamedValue[]
 
DocumentId
INo
LONG_NUMERIC_IDENTIFIER
>DOCUMENT.DOCUMENTID
DocumentStateCd
INo
Enum: DocumentState
>DOCUMENT.DOCUMENTSTATECD
VisibilityCd
INo
Enum: Visibility
>DOCUMENT.VISIBILITYCD
SecurityZoneId
INo
LONG_NUMERIC_IDENTIFIER
>DOCUMENT.SECURITYZONEID
DocumentCategoryId
INo
LONG_NUMERIC_IDENTIFIER
>DOCUMENT.DOCUMENTCATEGORYID
FolderId
INo
LONG_NUMERIC_IDENTIFIER
>DOCUMENT.FOLDERID
MediaBaseTypeId
INo
LONG_NUMERIC_IDENTIFIER
>DOCUMENT.MEDIABASETYPEID
SearchForMedia
INo
Boolean
SearchFolderRecursive
INo
Boolean
 
SearchTemplateOption
INo
Enum: SearchTemplateOption
 
SearchForInbox
INo
Boolean
 
ExternalTag
INo
LONG_ALPHANUMERIC_IDENTIFIER
>DOCUMENT.EXTERNALTAG
MofSyncId
INo
REGULAR_STRING
>DOCUMENT.MOFSYNCID
Owner
INo
LONG_NUMERIC_IDENTIFIER
>DOCUMENT.OWNER
Checkout
INo
LONG_NUMERIC_IDENTIFIER
>DOCUMENT.CHECKOUT
SearchDocumentFrom
INo
REGULAR_DATE
>DOCUMENT.DOCUMENTTS
SearchDocumentTo
INo
REGULAR_DATE
<DOCUMENT.DOCUMENTTS
SearchString
INo
SEARCHSTRING
>DOCUMENT.TITLE/DESCRIPTION
SearchStringOption
INo
Enum: SearchStringOption
 
SearchCreatedFrom
INo
REGULAR_TIMESTAMP
>DOCUMENT.CREATEDTS
SearchCreatedTo
INo
REGULAR_TIMESTAMP
>DOCUMENT.CREATEDTS
SearchValidUntilFrom
INo
REGULAR_DATE
>DOCUMENT.VALIDUNTILTS
SearchValidUntilTo
INo
REGULAR_DATE
>DOCUMENT.VALIDUNTILTS
LangShortCut
INo
SHORT_ALPHANUMERIC_IDENTIFIER
>DOCUMENT.LANGSHORTCUT
Free01..Free03
INo
SHORT_ALPHANUMERIC_IDENTIFIER
>DOCUMENT.FREE01..FREE03
Free04..Free09
INo
SHORT_STRING
>DOCUMENT.FREE04..FREE09
Free10..Free28
INo
REGULAR_STRING
>DOCUMENT.FREE10..FREE28
Free29..Free30
INo
EXTRALONG_STRING
>DOCUMENT.FREE29..FREE30
ArchiveStateCd
INo
Enum: ArchiveState
>DOCUMENT.ARCHIVESTATECD
AutoVersRef
INo
REGULAR_STRING
>DOCUMENT.AUTOVERSREF
SourceCd
INo
Enum: DocumentSource
>DOCUMENT.SOURCECD
CheckinOOMandantNo
INo
EXTRASHORT_NUMERIC_IDENTIFIER
>DOCUMENT.CHECKINOOMANDANTNO
UniqueFileNames
INo
Boolean
>DOCUMENT.UNIQUEFILENAMES
FullSearchString
INo
SEARCHSTRING
 
AccessUserId
INo
   
AccessActionCd
INo
   
OOLinkTypeId
INo
OOLinkValid
INo
BOTypeId
INo
   
BOId
INo
   
UsageId
INo
   
AutoPostProcessingStateCd
INo
Enum: AutoPostProcessingState
>DOCUMENT.AUTOPOSTPROCESSINGSTATECD
ManualPostProcessingStateCd
INo
Enum: ManualPostProcessingState
>DOCUMENT.MANUALPOSTPROCESSINGSTATECD
SortedBy
INo
LONG_STRING (Opt. Multi Content)
 
Kurzbeschreibung:
Dieser Service retourniert die Menge der Dokumente gruppiert nach der Dokumentkategorie.
Einschränkungen über DocumentStateCd sind möglich
Einschränkungen über VisibilityCd sind möglich
Einschränkungen über SecurityZoneId sind möglich
Einschränkungen über DocumentCategoryId sind möglich
Einschränkungen über FolderId sind möglich
Einschränkungen über MediaBaseType sind möglich
Einschränkungen über SearchForMedia sind möglich
Einschränkungen über ExternalTag sind möglich
Einschränkungen über die MofSyncId sind möglich
Einschränkungen über Owner sind möglich
Einschränkungen über Checkout sind möglich
Einschränkungen über DocumentTS sind möglich
Einschränkungen über ArchiveStateCd sind möglich
Einschränkungen über AutoVersRef sind möglich **)
Einschränkungen über SourceCd sind möglich ***)
Einschränkungen über UniqueFileNames sind möglich
Einschränkungen über LangShortCut sind möglich
Einschränkungen über die freien Attribute sind möglich
Einschränkungen über SearchString (siehe SearchStringOption) sind möglich
Einschränkungen über den Erstellungszeitpunkt (CreatedTS) sind möglich
Einschränkungen über das Gültigkeitsenddatum (ValidUntilTS) sind möglich
Einschränkungen über die Volltextsuche (FullSearchString) sind möglich
Einschränkungen über das AccessLog (AccessUserId, AccessActionCd) sind möglich
Einschränkungen über die OOLinks (OOLinkTypeId, OOLinkValid, BOTypeId, BOId) sind möglich
Einschränkungen über die UsageId (Zusammenfassung von Dokumentkategorien) sind möglich
Einschränkungen über AutoPostProcessingStateCd sind möglich
Einschränkungen über ManualPostProcessingStateCd sind möglich
Einschränkungen über CheckinOOMandantNo sind möglich
(Sortiert nach DocumentCategoryNo, es sei denn, die Sortierung wird mittels SortedBy übersteuert.)
SearchFolderRecursive: false (default): im Folder mit FolderId, true: im Folder und seinen Subfoldern (diese Option wird nur ausgewertet wenn eine FolderId angegeben wurde!)
SearchTemplateOption: 0: ALL, 1: DOCUMENTS_ONLY, 2: TEMPLATES_ONLY
SearchForMedia: false (default): kein Einfluss, true: Dokument muss Medienbasistyp haben
SearchForInbox: false (default): kein Einfluss, true: Dokument muss verfügbar (AVAILABLE) und noch nicht archiviert (NOT_ARCHIVED) sein
SearchStringOption: 1: TITLE_ONLY (Title), 2: TITLE_AND_DESCRIPTION (Title, Subtitle, Description und ExternalTag)
FullSearchString: Wenn mitgegeben wird eine Volltextsuche vorangeschaltet
AccessUserId, AccessActionCd: Wenn mitgegeben wird das AccessLog mit einbezogen
OOLinkTypeId, OOLinkValid, BOTypeId, BOId: Wenn mitgegeben werden die OOLinks mit einbezogen
UsageId: Wenn mitgegeben wird die Usage mit einbezogen
Fehlerhandling/Plausibilisierung:
Generell gelten die Regeln (PK, AK, FK, Unique, NotNull) der Datenbank. Die zusätzlichen Fehler sind:
  • Aufgrund von Validator-Prüfungen (VD)
  • Wenn der FullSearchString mitgegeben wird aber leer ist (1)
  • Wenn FullSearchString mitgegeben wird aber noch kein Such-Index zur Verfügung steht (2)
  • Wenn FullSearchString mitgegeben aber nicht als gültig befunden wird (3)
  • Wenn FullSearchString mitgegeben wird und die Suche in einem unerwarteten Fehlers exception endet (4)
  • Wenn der AccessUser über die OOUserId nicht gefunden wird (5)
  • Wenn der OOLinkType über den OOLinkTypeCode nicht gefunden wird (6)
  • Wenn der BOType über den BOTypeName nicht gefunden wird (7)
**) Das Feld AutoVersRef wird von der automatischen Versionierung benutzt und darf nicht manuell manipuliert werden. Die Suche auf diesem String-Feld erfolgt abweichend vom Standardverhalten LIKE hier mit EQUAL!
***) Das Feld SourceCd darf nicht manuell manipuliert werden!
Bemerkungen:
(1): SearcherEmptyStr
(2): SearcherSearchIdxNAvail
(3): SearcherInvExpression
(4): SearcherGeneralExc
(5): GetUsrNFndByOOUserId
(6): GetOOLinkTypeNFndByOOLinkTypeCode
(7): GetBOTypeNFndByBOTypeNm
Defaultwerte:
  • SearchStringOption: TITLE_AND_DESCRIPTION
  • SearchTemplateOption: ALL
  • SearchForInbox: false
  • SearchFolderRecursive: false
SortedBy
Beim sortedBy-Parameter können mehrere Resultat-Spalten (z.B. Attr1 ascending, Attr2 descending, Attr3 descending) angegeben werden. Die Resultat-Spalten sind dabei durch Komma getrennt.
Die gültigen Sortierungen sind: asc, ascending und desc, descending.