Services

SearchDocuments

SearchDocuments
Main
History-Relevant
Rückgabewert
Document[]
RET
Document (Struct) Array
  
Parameterliste
SearchString
IN
SEARCHSTRING
  
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
Owner
INo
LONG_NUMERIC_IDENTIFIER
>DOCUMENT.OWNER
Checkout
INo
LONG_NUMERIC_IDENTIFIER
>DOCUMENT.CHECKOUT
LangShortCut
INo
SHORT_ALPHANUMERIC_IDENTIFIER
>DOCUMENT.LANGSHORTCUT
SortedBy
INo
LONG_STRING (Opt. Multi Content)
Kurzbeschreibung:
Dieser Service retourniert alle Einträge welche über die Volltextsuche auf dem Index gefunden werden.
Selbstverständlich werden nur die sichtbaren Dokumente retourniert für welche der ContextUser auch das Leserecht besetzt.
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 Owner sind möglich
Einschränkungen über Checkout sind möglich
Einschränkungen über LangShortCut sind möglich
(Sortiert nach DocumentId, es sei denn, die Sortierung wird mittels SortedBy übersteuert.)
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 SearchString leer ist (1)
  • Wenn noch kein Such-Index zur Verfügung steht (2)
  • Wenn der SearchString nicht als gültig befunden wird (3)
  • Wenn die Suche aufgrund eines unerwarteten Fehlers exception fehlschlägt (4)
Hinweis: Seit der Version 13.00.03 besitzt der universelle Service „GetDocumentList“ unter anderem auch die Fähigkeit der Volltextsuche. Es empfiehlt sich deshalb alle Listenabfragen auf DMAS-Dokumenten mit den Services „GetDocumentListCategoryCatalog“ bzw. „GetDocumentList“ durchzuführen.
Bemerkungen:
VD: siehe Validator-Fehler
(1): SearcherEmptyStr
(2): SearcherSearchIdxNAvail
(3): SearcherInvExpression
(4): SearcherGeneralExc
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.