Services

GetBOMediaFileList

GetBOMediaFileList
Main
  
Rückgabewert
MediaFile[]
RET
MediaFile (Struct) Array
Parameterliste
BOTypeId
IN
LONG_NUMERIC_IDENTIFIER
BOTypeName
IN
LONG_ALPHANUMERIC_IDENTIFIER
BOIds
IN
LONG_STRING
BOIdSegs
IN
SHORT_NUMERIC_IDENTIFIER
NamedValueArray
INo
NamedValue[]
DocumentId
INo
LONG_NUMERIC_IDENTIFIER
DocumentCategoryId
INo
LONG_NUMERIC_IDENTIFIER
VersionId
INo
LONG_NUMERIC_IDENTIFIER
LangShortCut
INo
SHORT_ALPHANUMERIC_IDENTIFIER
OOLinkTypeId
INo
LONG_NUMERIC_IDENTIFIER
OOLinkValid
INo
REGULAR_DATE
MediaBaseTypeId
INo
LONG_NUMERIC_IDENTIFIER
MediaSubTypeId
INo
LONG_NUMERIC_IDENTIFIER
SortedBy
INo
LONG_STRING (Opt. Multi Content)
Kurzbeschreibung:
Dieser Service retourniert alle MediaFiles (MediaSubTypeId > 0) der Tabelle FILE welche den Kriterien genügen und ergänzt diese Liste mit potentiellen MediaFiles welche aber zum Abfragezeitpunkt physikalisch (noch) nicht existieren da sie den Erstellungstyp ONREQUEST besitzen. (Wenn BOTypeId = 0, wird über BOTypeName gesucht!)
Einschränkungen über DocumentId sind möglich (konkretes Dokument)
Einschränkungen über DocumentCategroyId sind möglich (konkrete Dokumentkategorie)
Einschränkungen über VersionId sind möglich (konkrete Version eines bestimmten Dokuments)
Einschränkungen über LangShortCut sind möglich
Einschränkungen über OOLinks (OOLinkTypeId, OOLinkValid) sind möglich
Einschränkungen über MediaBaseType sind möglich
Einschränkungen über MediaSubType sind möglich
(Sortiert nach BOId (Aufzählungsreihenfolge), MediaBaseTypeCode, MediaSubTypeCode, RealFileName (bei OnRequest ab ConversionBase), DocumentId, es sei denn, die Sortierung wird mittels SortedBy übersteuert.)
Wird BOIdSegs (Anzahl Segmente der BOId) nicht angegeben, also 0 belassen, so wird 1 verwendet! Die MediaFile-Struktur ist im Wesentlichen die File-Struktur inklusive ein paar zusätzlicher MediaFile-Informationen!
MediaFiles der Resultatliste welche gar nicht (auch nicht als „Hülle“) in der DB existieren, weisen die „FileId“ 0 aus, können aber dennoch mit dem auf dem Service „LoadFile“ ergänzten Parameter „MediaFileId“ AdHoc angefordert werden, vorausgesetzt die Konvertierungsbasis ist vorhanden! Das „MediaFileId„- Format ist „VersionId.MediaSubTypeId“.
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 die BOId-Aufzählung leer ist (1)
  • Wenn die Medienverwaltung nicht lizenziert ist (2)
  • Wenn die MediaSubType-Angabe nicht zur MediaBaseType-Angabe passt (3)
Bemerkungen:
VD: siehe Validator-Fehler
(1): GetBOMdaFileListBOIdsIsEmpty
(2): GetBOMdaFileListNWhtMdaOpn
(3): GetBOMdaFileListMdaSubTypeMs
Hintergrund: Als Basisabfrage dient eine Abfrage über die Dokumente (es könnte ja sein, dass zu einem Dokument gar keine physikalischen Dateien existieren!) Anhand der Dokumentliste werden anschliessend über deren aktuell relevante Version die Dateien ausgelesen und allenfalls (MediaSubType ONREQUEST) mit weiteren potentiellen MediaFiles angereichert!
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.