Class AnyRoom
java.lang.Object
eu.c6.gibraltar.api.common.CObject
eu.c6.gibraltar.api.managers.rooms.AnyRoom
- All Implemented Interfaces:
ICObject,IAnyRoom,IApiRoomConstants,Serializable,Cloneable
The Class AnyRoom to get, create and update folders.
- See Also:
-
Field Summary
Fields inherited from interface eu.c6.gibraltar.api.managers.rooms.IApiRoomConstants
ADMINISTRATORS, BROWSING_MODE, BROWSING_MODE_FLAT, BROWSING_MODE_FOLDERS, BROWSING_MODE_MIXED, BROWSING_MODE_VIEWS, COLLECTIONS, COLORIZATION, COLUMNS, COLUMNS_TYPE_MAIN, COLUMNS_TYPE_RELATIONS, CONTRIBUTORS, CONTROLLED_EXPORT, CONTROLLED_PRINT, CONTROLLED_VIEW, DESCRIPTIONS, ID, IMG_RESOURCE_ID, MASSUPDATE_METADATA, MEMBERS, NAME, ONLY_VERIFIED_CONTENTS_ALLOWED, READERS, READERS_PERMISSIONS, READERS_PERMISSIONS_CHANGE_STATE, READERS_PERMISSIONS_COMMENT, READERS_PERMISSIONS_PROPERTIES_EDIT, RSS_FEED_ENABLED, STATIC_LINK_FORBIDDEN, TITLES, VERSION, VIEWERS, VIEWS_CONFIGFields inherited from interface eu.c6.gibraltar.api.common.ICObject
CHARSET, FIELD_SEPARATOR_DOT, FIELD_SEPARATOR_PATH -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionGets the administrators.Gets the browsing mode.Gets the contributors.getId()Gets identifier of the room.getName()Gets the room name.Gets the readers.Gets the viewers.voidsetAdministrators(List<ApiMember> members) Sets the administrators.voidsetBrowsingMode(String mode) Sets the browsing mode.voidsetCollections(List<String> list) Sets the collections used in the room.voidsetColorization(String colorization) Sets the colorization configuration to use in the room if you want to drive configuration at room level.voidsetColumns(String type, List<ApiColumn> columns) Sets the columns to use in the room for main contents or relations.voidsetContributors(List<ApiMember> members) Sets the contributors.voidsetControlledExport(String controlledConfig) Sets the controlled export configuration to use in the room if you want to drive configuration at room level.voidsetControlledPrint(String controlledConfig) Sets the controlled print configuration to use in the room if you want to drive configuration at room level.voidsetControlledView(String controlledConfig) Sets the controlled view configuration to use in the room if you want to drive configuration at room level.voidsetDescriptions(Map<Locale, String> descriptions) Sets the localized descriptions.voidSets the identifier of the folder.voidsetImgResourceId(String imgresourceid) Sets the image resource identifier used to display room.voidsetMassupdateMetadata(List<String> metadata) Sets the metadata list you can update with mass update feature.voidSets the room name.voidsetOnlyVerifiedContentsAllowed(boolean enabled) Sets the only verified contents allowed value.voidsetReaders(List<ApiMember> members) Sets the readers.voidsetReadersPermissions(List<String> permissions) Sets the additional readers ACL permissions in the room.voidsetRssFeedEnabled(boolean enabled) Sets the RSS feed enabled value.voidsetStaticLinkForbidden(boolean enabled) Sets the static link forbidden value.voidSets the room localized titles displayed in Any.voidsetVersion(String version) Sets the version of contents displayed in the room.voidsetViewers(List<ApiMember> members) Sets the viewers.voidsetViewsConfig(List<IView> views) Sets the views to use in the room.Methods inherited from class eu.c6.gibraltar.api.common.CObject
addIntoList, addValueIntoList, buildPath, clearList, clone, clone, clone, contains, containsField, convertFieldNameToJsonPath, convertJsonPathToFieldName, equals, get, getBoolean, getBoolean, getDate, getDate, getDouble, getDouble, getFieldNames, getFieldNamesFlattenList, getFieldNamesList, getInputStream, getInt, getInt, getList, getListNestedObject, getListNestedObject, getListNestedObject, getListNestedObjectByAttribute, getListNestedObjectByAttribute, getListSize, getListString, getLocalDateTime, getLocalDateTime, getLong, getLong, getNestedObject, getNestedObject, getNestedObject, getNestedObjectNamesList, getOutputStream, getReader, getString, getString, insertIntoList, isBoolean, isDate, isDateList, isDouble, isEmpty, isFieldEmpty, isInt, isJSONValid, isList, isNestedObject, isNestedObjectList, isString, load, load, merge, mergeDeep, parse, remove, removeFromList, removeValueFromList, replaceIntoList, resetField, set, set, set, set, set, set, set, set, set, setList, setNull, textValue, toFlattenMapValues, toJson, toMap, toString, toString
-
Constructor Details
-
AnyRoom
public AnyRoom()Instantiates a new any room. -
AnyRoom
Instantiates a new any room from object with fields.- Parameters:
object- the object
-
AnyRoom
public AnyRoom(com.fasterxml.jackson.databind.JsonNode jsonNode) Instantiates a new any room from JSON node.- Parameters:
jsonNode- the JSON node
-
-
Method Details
-
getId
Description copied from interface:IAnyRoomGets identifier of the room. -
setId
Description copied from interface:IAnyRoomSets the identifier of the folder. Not used when you create or update. It is only for internal use by the API. -
getName
Description copied from interface:IAnyRoomGets the room name. -
setName
Description copied from interface:IAnyRoomSets the room name.Required when you create a new room. It must only contains letters and numbers in lower case, no special characters are accepted.
-
getBrowsingMode
Description copied from interface:IAnyRoomGets the browsing mode.- Specified by:
getBrowsingModein interfaceIAnyRoom- Returns:
- the browsing mode ("flat", "folders" or "mixed")
-
setBrowsingMode
Description copied from interface:IAnyRoomSets the browsing mode.- Specified by:
setBrowsingModein interfaceIAnyRoom- Parameters:
mode- the new browsing mode ("flat", "folders" or "mixed")
-
getViewers
Description copied from interface:IAnyRoomGets the viewers. Viewers are user allowed to see the room but cannot browse them until access request is accepted.- Specified by:
getViewersin interfaceIAnyRoom- Returns:
- the viewers
-
setViewers
Description copied from interface:IAnyRoomSets the viewers. Viewers are user allowed to see the room but cannot browse them until access request is accepted.- Specified by:
setViewersin interfaceIAnyRoom- Parameters:
members- the new viewers. Each member can be a group or a user.
-
getContributors
Description copied from interface:IAnyRoomGets the contributors.- Specified by:
getContributorsin interfaceIAnyRoom- Returns:
- the members of contributors
-
setContributors
Description copied from interface:IAnyRoomSets the contributors.- Specified by:
setContributorsin interfaceIAnyRoom- Parameters:
members- the new contributors. Each member can be a group or a user.
-
getReaders
Description copied from interface:IAnyRoomGets the readers.- Specified by:
getReadersin interfaceIAnyRoom- Returns:
- the members of readers
-
setReaders
Description copied from interface:IAnyRoomSets the readers.- Specified by:
setReadersin interfaceIAnyRoom- Parameters:
members- the new readers. Each member can be a group or a user.
-
getAdministrators
Description copied from interface:IAnyRoomGets the administrators.- Specified by:
getAdministratorsin interfaceIAnyRoom- Returns:
- the members of administrators
-
setAdministrators
Description copied from interface:IAnyRoomSets the administrators.- Specified by:
setAdministratorsin interfaceIAnyRoom- Parameters:
members- the new administrators. Each member can be a group or a user.
-
setTitles
Description copied from interface:IAnyRoomSets the room localized titles displayed in Any.Example
-
setDescriptions
Description copied from interface:IAnyRoomSets the localized descriptions.- Specified by:
setDescriptionsin interfaceIAnyRoom- Parameters:
descriptions- the localized descriptions
-
setCollections
Description copied from interface:IAnyRoomSets the collections used in the room.- Specified by:
setCollectionsin interfaceIAnyRoom- Parameters:
list- the new collections
-
setVersion
Description copied from interface:IAnyRoomSets the version of contents displayed in the room.Do not set it if you want to display all versions. Use "latest" value if you want to only display latest versions.
- Specified by:
setVersionin interfaceIAnyRoom- Parameters:
version- the new version to use
-
setControlledView
Description copied from interface:IAnyRoomSets the controlled view configuration to use in the room if you want to drive configuration at room level.- Specified by:
setControlledViewin interfaceIAnyRoom- Parameters:
controlledConfig- the new controlled view configuration to use
-
setControlledPrint
Description copied from interface:IAnyRoomSets the controlled print configuration to use in the room if you want to drive configuration at room level.- Specified by:
setControlledPrintin interfaceIAnyRoom- Parameters:
controlledConfig- the new controlled print configuration to use
-
setControlledExport
Description copied from interface:IAnyRoomSets the controlled export configuration to use in the room if you want to drive configuration at room level.- Specified by:
setControlledExportin interfaceIAnyRoom- Parameters:
controlledConfig- the new controlled export configuration to use
-
setColorization
Description copied from interface:IAnyRoomSets the colorization configuration to use in the room if you want to drive configuration at room level.- Specified by:
setColorizationin interfaceIAnyRoom- Parameters:
colorization- the new colorization configuration to use
-
setViewsConfig
Description copied from interface:IAnyRoomSets the views to use in the room.Only compatible with browsing mode
IApiRoomConstants.BROWSING_MODE_VIEWSorIApiRoomConstants.BROWSING_MODE_MIXED- Specified by:
setViewsConfigin interfaceIAnyRoom- Parameters:
views- the new views config
-
setMassupdateMetadata
Description copied from interface:IAnyRoomSets the metadata list you can update with mass update feature.- Specified by:
setMassupdateMetadatain interfaceIAnyRoom- Parameters:
metadata- the new mass update metadata list
-
setReadersPermissions
Description copied from interface:IAnyRoomSets the additional readers ACL permissions in the room.- Specified by:
setReadersPermissionsin interfaceIAnyRoom- Parameters:
permissions- the new readers permissions. Possible values are "content:change_state", "content:properties:edit" or "content:comment:*"
-
setImgResourceId
Description copied from interface:IAnyRoomSets the image resource identifier used to display room.- Specified by:
setImgResourceIdin interfaceIAnyRoom- Parameters:
imgresourceid- the new image resource identifier. Image resource must refer to an existing room image imported in Any.
-
setColumns
Description copied from interface:IAnyRoomSets the columns to use in the room for main contents or relations.- Specified by:
setColumnsin interfaceIAnyRoom- Parameters:
type- the type. Possible values are "main" or "relations".columns- the columns
-
setRssFeedEnabled
public void setRssFeedEnabled(boolean enabled) Description copied from interface:IAnyRoomSets the RSS feed enabled value.- Specified by:
setRssFeedEnabledin interfaceIAnyRoom- Parameters:
enabled- the new RSS feed enabled value.
-
setOnlyVerifiedContentsAllowed
public void setOnlyVerifiedContentsAllowed(boolean enabled) Description copied from interface:IAnyRoomSets the only verified contents allowed value. When only verified content is allowed any content linked or created in the room must match a least a collection of the room.- Specified by:
setOnlyVerifiedContentsAllowedin interfaceIAnyRoom- Parameters:
enabled- the new only verified contents allowed value
-
setStaticLinkForbidden
public void setStaticLinkForbidden(boolean enabled) Description copied from interface:IAnyRoomSets the static link forbidden value. When static link is forbidden you cannot manually add a content to the room.- Specified by:
setStaticLinkForbiddenin interfaceIAnyRoom- Parameters:
enabled- the new static link forbidden value
-