Class AnyFolder
java.lang.Object
eu.c6.gibraltar.api.common.CObject
eu.c6.gibraltar.api.managers.folders.AnyFolder
- All Implemented Interfaces:
ICObject,IAnyFolder,IAnyFolderConstants,Serializable,Cloneable
The Class AnyFolder to get, create and update folders.
- See Also:
-
Field Summary
Fields inherited from interface eu.c6.gibraltar.api.managers.folders.IAnyFolderConstants
ALLOW_EDIT, CONTRIBUTORS, DESCRIPTIONS, HAS_SECURITY_OVERWRITE, ID, NAME, PARENT_ID, TITLESFields inherited from interface eu.c6.gibraltar.api.common.ICObject
CHARSET, FIELD_SEPARATOR_DOT, FIELD_SEPARATOR_PATH -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionGets folder contributors list if security is overwritten.getId()Gets identifier of the folder.getName()Gets the folder name.Gets the parent identifier.booleanChecks if the folder has security overwritebooleanChecks if the folder allows edit for current user.voidsetAllowEdit(boolean allowEdit) Sets the allow edit value.voidsetContributors(List<ApiMember> members) Sets the list of contributors members.voidsetDescriptions(Map<Locale, String> descriptions) Sets the localized descriptions.voidSets the identifier of the folder.voidSets the folder name.voidsetParentId(String parentId) Sets the parent identifier.voidsetSecurityOverwrite(boolean overwrite) Sets the security overwrite value.voidSets the folder localized titles displayed in Any.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
-
AnyFolder
public AnyFolder()Instantiates a new any folder. -
AnyFolder
Instantiates a new any folder from object with fields.- Parameters:
object- the object
-
AnyFolder
public AnyFolder(com.fasterxml.jackson.databind.JsonNode jsonNode) Instantiates a new any folder from JSON node.- Parameters:
jsonNode- the JSON node
-
-
Method Details
-
getId
Description copied from interface:IAnyFolderGets identifier of the folder.- Specified by:
getIdin interfaceIAnyFolder- Returns:
- the identifier. When you get the object from the server the identifier is the global unique identifier.
-
setId
Description copied from interface:IAnyFolderSets the identifier of the folder. Not used when you create or update. It is only for internal use by the API.- Specified by:
setIdin interfaceIAnyFolder- Parameters:
id- the folder global unique identifier
-
getParentId
Description copied from interface:IAnyFolderGets the parent identifier. Can be a folder identifier or a room identifier if you are at the top level of the folder tree.- Specified by:
getParentIdin interfaceIAnyFolder- Returns:
- the parent id
-
setParentId
Description copied from interface:IAnyFolderSets the parent identifier.Not used when you create or update. It is only for internal use by the API. Can be a folder identifier or a room identifier if you are at the top level of the folder tree.
- Specified by:
setParentIdin interfaceIAnyFolder- Parameters:
parentId- the new parent identifier
-
isAllowEdit
public boolean isAllowEdit()Description copied from interface:IAnyFolderChecks if the folder allows edit for current user.- Specified by:
isAllowEditin interfaceIAnyFolder- Returns:
- true, if current user can edit
-
setAllowEdit
public void setAllowEdit(boolean allowEdit) Description copied from interface:IAnyFolderSets the allow edit value. Only for internal use by the API, you cannot set it in Any with the API.- Specified by:
setAllowEditin interfaceIAnyFolder- Parameters:
allowEdit- the new allow edit value
-
hasSecurityOverwrite
public boolean hasSecurityOverwrite()Description copied from interface:IAnyFolderChecks if the folder has security overwrite- Specified by:
hasSecurityOverwritein interfaceIAnyFolder- Returns:
- true, if folder has security overwrite
-
setSecurityOverwrite
public void setSecurityOverwrite(boolean overwrite) Description copied from interface:IAnyFolderSets the security overwrite value.- Specified by:
setSecurityOverwritein interfaceIAnyFolder- Parameters:
overwrite- the new allow edit value
-
getContributors
Description copied from interface:IAnyFolderGets folder contributors list if security is overwritten.- Specified by:
getContributorsin interfaceIAnyFolder- Returns:
- List of members. Each member can be a group or user.
-
setContributors
Description copied from interface:IAnyFolderSets the list of contributors members. Only used if security is overwritten.- Specified by:
setContributorsin interfaceIAnyFolder- Parameters:
members- the new list of user/group members.
-
getName
Description copied from interface:IAnyFolderGets the folder name.- Specified by:
getNamein interfaceIAnyFolder- Returns:
- the folder name used in folder path
-
setName
Description copied from interface:IAnyFolderSets the folder name.You must distinguish the folder name and the folder titles. Folder titles are the nice localized labels displayed in Any and the folder name is used to build unique folder path into the room.
- Specified by:
setNamein interfaceIAnyFolder- Parameters:
name- the new name
-
setTitles
Description copied from interface:IAnyFolderSets the folder localized titles displayed in Any.Example
- Specified by:
setTitlesin interfaceIAnyFolder- Parameters:
titles- the localized titles
-
setDescriptions
Description copied from interface:IAnyFolderSets the localized descriptions.- Specified by:
setDescriptionsin interfaceIAnyFolder- Parameters:
descriptions- the localized descriptions
-