View Sets allow the customization of permissions with respect to metadata display and evaluation. More...

Classes
struct	ViewMetadata
	Metadata entry in View Set. More...

struct	ViewSetType
	Singular View Set Component. More...

struct	ViewSet
	Complete View Set. More...

struct	MetadataIcon
	Icon for SELECT/MULTISELECT/HYPERSELECT metadata. More...

Enumerations
enum	ViewType { VTNONE, VTSMALL, VTMEDIUM, VTLARGE, VTLIST, VTDETAIL, VTSORT, VTWRITE, VTQSEARCH, VTASEARCH, VTCOLLECTION, VTQSFILTER, VTUPLOAD, VTHYBRID }
	Enumeration for View Set component types. More...

Functions
int	getViewSet (xsd__string sessionID, xsd__string viewSetID, xsd__string langID, std::vector< struct ViewSet > &viewSet)
	Get a View Set definition. More...

int	getViewSetOfGroup (xsd__string sessionID, xsd__string groupID, xsd__string langID, std::vector< struct ViewSet > &viewSet)
	Get the View Set defined for a specific UserGroup. More...

int	getViewSetOfGroupMediaShare (xsd__string sessionID, xsd__string groupID, xsd__string mediaShareID, xsd__string langID, std::vector< struct ViewSet > &viewSet)
	Get the View Set defined for a specific combination of UserGroup and MediaShare. More...

int	getAllViewSets (xsd__string sessionID, xsd__string langID, std::vector< struct ViewSet > &viewSets)
	Get all defined view sets. More...

int	createViewSet (xsd__string sessionID, xsd__string setName, std::vector< struct ViewSetType > viewTypes, xsd__int &viewSetID)
	Create a new View Set. More...

int	deleteViewSet (xsd__string sessionID, xsd__string viewSetID, std::vector< struct noret > &)
	Delete a View Set. More...

int	assignViewSetToGroup (xsd__string sessionID, xsd__string viewSetID, xsd__string groupID, std::vector< struct noret > &)
	Assign a View Set to a UserGroup. More...

int	unassignViewSetFromGroup (xsd__string sessionID, xsd__string groupID, std::vector< struct noret > &)
	Remove assignment of View Set to UserGroup. More...

int	assignViewSetToGroupMediaShare (xsd__string sessionID, xsd__string viewSetID, xsd__string groupID, xsd__string mediaShareID, std::vector< struct noret > &)
	Assign View Set to a combination of UserGroup and MediaShare. More...

int	unassignViewSetFromGroupMediaShare (xsd__string sessionID, xsd__string groupID, xsd__string mediaShareID, std::vector< struct noret > &)
	Remove assignment of View Set from a combination of UserGroup and MediaShare. More...

int	replaceViewSet (xsd__string sessionID, xsd__string viewSetID, xsd__string setName, std::vector< struct ViewSetType > viewTypes, std::vector< struct noret > &)
	Replace existing View Set definition. More...

int	addMetadataIcon (xsd__string sessionID, struct MetadataIcon icon, int &id)
	Add a new metadata icon in the icon pool. More...

int	changeMetadataIcon (xsd__string sessionID, struct MetadataIcon icon, std::vector< struct noret > &)
	Change existing icon in the icon pool. More...

int	getAllMetadataIcons (xsd__string sessionID, std::vector< struct MetadataIcon > &icons)
	Retrieve all metadata icons stored in the icon pool. More...

int	getMetadataIcon (xsd__string sessionID, xsd__string iconID, std::vector< struct MetadataIcon > &icon)
	Retrieve a specific metadata icon from the icon pool. More...

int	removeMetadataIcon (xsd__string sessionID, xsd__string iconID, std::vector< struct noret > &)
	Remove a metadata icon from the icon pool. More...

Detailed Description

View Sets allow the customization of permissions with respect to metadata display and evaluation.

A View Set encompassing thumbnail, list and detail views as well as sort settings and the search settings is generally associated with a UserGroup, another View Set containing only the writability information for certain metadata is associated with a combination of UserGroup and MediaShare.

Enumeration Type Documentation

◆ ViewType

enum ViewType

Enumeration for View Set component types.

Enumerator
VTNONE	Fallback ...
VTSMALL	Small Thumbnails.
VTMEDIUM	Medium Thumbnails.
VTLARGE	Large Thumbnails.
VTLIST	List View.
VTDETAIL	Detail View.
VTSORT	Sortable Metadata.
VTWRITE	Writable Metadata.
VTQSEARCH	Metadata allowed for QuickSearch.
VTASEARCH	Metadata allowed for Advanced Search.
VTCOLLECTION	Metadata allowed for Collection display.
VTQSFILTER	Filter for QuickSearch items.
VTUPLOAD	Mandatory items for default upload action.
VTHYBRID	Items for a hybrid view.

Function Documentation

◆ addMetadataIcon()

int addMetadataIcon	(	xsd__string	sessionID,
		struct MetadataIcon	icon,
		int &	id
	)

Add a new metadata icon in the icon pool.

icon.iconID is ignored.

Parameters

[in]	sessionID	Session ID (must be Administrator)
[in]	icon	MetadataIcon data structure.
[out]	id	Database ID of icon (either added or changed).

◆ assignViewSetToGroup()

int assignViewSetToGroup	(	xsd__string	sessionID,
		xsd__string	viewSetID,
		xsd__string	groupID,
		std::vector< struct noret > &
	)

Assign a View Set to a UserGroup.

Parameters

[in]	sessionID	Session ID (must be Administrator)
[in]	viewSetID	ID of View Set
[in]	groupID	ID of UserGroup
[out]	none

◆ assignViewSetToGroupMediaShare()

int assignViewSetToGroupMediaShare	(	xsd__string	sessionID,
		xsd__string	viewSetID,
		xsd__string	groupID,
		xsd__string	mediaShareID,
		std::vector< struct noret > &
	)

Assign View Set to a combination of UserGroup and MediaShare.

Parameters

[in]	sessionID	Session ID (must be Administrator)
[in]	viewSetID	ID of View Set
[in]	groupID	ID of UserGroup
[in]	mediaShareID	ID of MediaShare
[out]	none

◆ changeMetadataIcon()

int changeMetadataIcon	(	xsd__string	sessionID,
		struct MetadataIcon	icon,
		std::vector< struct noret > &
	)

Change existing icon in the icon pool.

Parameters

[in]	sessionID	Session ID (must be Administrator)
[in]	icon	MetadataIcon data structure
[out]	none.

◆ createViewSet()

int createViewSet	(	xsd__string	sessionID,
		xsd__string	setName,
		std::vector< struct ViewSetType >	viewTypes,
		xsd__int &	viewSetID
	)

Create a new View Set.

Parameters

[in]	sessionID	Session ID (must be Administrator)
[in]	setName	Name of new View Set
[in]	viewTypes	Array of ViewSetType structures defining the View Set
[out]	viewSetID	ID of newly created View Set

◆ deleteViewSet()

int deleteViewSet	(	xsd__string	sessionID,
		xsd__string	viewSetID,
		std::vector< struct noret > &
	)

Delete a View Set.

Parameters

[in]	sessionID	Session ID (must be Administrator)
[in]	viewSetID	ID of View Set to delete
[out]	none

◆ getAllMetadataIcons()

int getAllMetadataIcons	(	xsd__string	sessionID,
		std::vector< struct MetadataIcon > &	icons
	)

Retrieve all metadata icons stored in the icon pool.

Parameters

[in]	sessionID	Session ID (must be Administrator)
[out]	icons	Array of MetadataIcon data structures for all icons.

◆ getAllViewSets()

int getAllViewSets	(	xsd__string	sessionID,
		xsd__string	langID,
		std::vector< struct ViewSet > &	viewSets
	)

Get all defined view sets.

Parameters

[in]	sessionID	Session ID (must be Administrator)
[in]	langID	Language ID
[out]	viewSets	Array of View Set definitions

◆ getMetadataIcon()

int getMetadataIcon	(	xsd__string	sessionID,
		xsd__string	iconID,
		std::vector< struct MetadataIcon > &	icon
	)

Retrieve a specific metadata icon from the icon pool.

Parameters

[in]	sessionID	Session ID (must be Administrator)
[in]	iconID	Database ID of icon to retrieve
[out]	icon	MetadataIcon data structure for specific icon.

◆ getViewSet()

int getViewSet	(	xsd__string	sessionID,
		xsd__string	viewSetID,
		xsd__string	langID,
		std::vector< struct ViewSet > &	viewSet
	)

Get a View Set definition.

Parameters

[in]	sessionID	Session ID
[in]	viewSetID	ID of View Set
[in]	langID	Language ID
[out]	viewSet	View Set definition

◆ getViewSetOfGroup()

int getViewSetOfGroup	(	xsd__string	sessionID,
		xsd__string	groupID,
		xsd__string	langID,
		std::vector< struct ViewSet > &	viewSet
	)

Get the View Set defined for a specific UserGroup.

Parameters

[in]	sessionID	Session ID (must be Administrator or Member of resp. UserGroup)
[in]	groupID	ID of UserGroup
[in]	langID	Language ID
[out]	viewSet	View Set definition

◆ getViewSetOfGroupMediaShare()

int getViewSetOfGroupMediaShare	(	xsd__string	sessionID,
		xsd__string	groupID,
		xsd__string	mediaShareID,
		xsd__string	langID,
		std::vector< struct ViewSet > &	viewSet
	)

Get the View Set defined for a specific combination of UserGroup and MediaShare.

Parameters

[in]	sessionID	Session ID (must be Administrator or member of resp. UserGroup)
[in]	groupID	ID of UserGroup
[in]	mediaShareID	ID of MediaShare
[in]	langID	Language ID
[out]	viewSet	View Set definition

◆ removeMetadataIcon()

int removeMetadataIcon	(	xsd__string	sessionID,
		xsd__string	iconID,
		std::vector< struct noret > &
	)

Remove a metadata icon from the icon pool.

Parameters

[in]	sessionID	Session ID (must be Administrator)
[in]	incoID	Database ID of icon to remove
[out]	none.

◆ replaceViewSet()

int replaceViewSet	(	xsd__string	sessionID,
		xsd__string	viewSetID,
		xsd__string	setName,
		std::vector< struct ViewSetType >	viewTypes,
		std::vector< struct noret > &
	)

Replace existing View Set definition.

Parameters

[in]	sessionID	Session ID (must be Administrator)
[in]	viewSetID	ID of View Set to replace
[in]	setName	New name of View Set
[in]	viewTypes	New View Set definition.
[out]	none

◆ unassignViewSetFromGroup()

int unassignViewSetFromGroup	(	xsd__string	sessionID,
		xsd__string	groupID,
		std::vector< struct noret > &
	)

Remove assignment of View Set to UserGroup.

Parameters

[in]	sessionID	Session ID (must be Administrator)
[in]	groupID	ID of UserGroup
[out]	none

◆ unassignViewSetFromGroupMediaShare()

int unassignViewSetFromGroupMediaShare	(	xsd__string	sessionID,
		xsd__string	groupID,
		xsd__string	mediaShareID,
		std::vector< struct noret > &
	)

Remove assignment of View Set from a combination of UserGroup and MediaShare.

Parameters

[in]	sessionID	Session ID (must be Administrator)
[in]	groupID	ID of UserGroup
[in]	mediaShareID	ID of MediaShare
[out]	none

Classes

Enumerations

Functions

Detailed Description

Enumeration Type Documentation

◆ ViewType

Function Documentation

◆ addMetadataIcon()

◆ assignViewSetToGroup()

◆ assignViewSetToGroupMediaShare()

◆ changeMetadataIcon()

◆ createViewSet()

◆ deleteViewSet()

◆ getAllMetadataIcons()

◆ getAllViewSets()

◆ getMetadataIcon()

◆ getViewSet()

◆ getViewSetOfGroup()

◆ getViewSetOfGroupMediaShare()

◆ removeMetadataIcon()

◆ replaceViewSet()

◆ unassignViewSetFromGroup()

◆ unassignViewSetFromGroupMediaShare()