Package ch.ivyteam.ivy.cm
Interface ContentObject
- All Known Subinterfaces:
IContentObject
public interface ContentObject
Content Object
- Since:
- 9.4
- API:
- This is a public API.
-
Method Summary
Modifier and TypeMethodDescriptionchild()
Returns to the content object child accessory.children()
Gets all children of this content object.cms()
Returns the content management system this content object belongs to.void
delete()
Deletes this content object and all its children.boolean
exists()
If a content object exists or not.boolean
isRoot()
Whether this is the root content object or not.meta()
Returns the content object meta.name()
Gets the nameparent()
Gets the parent content object or null if this content object is already the root.uri()
Gets the urivalue()
Gets the accessory for the content object values.values()
Gets all values of this content object.
-
Method Details
-
name
String name()Gets the name- Returns:
- name
- API:
- This public API is available in Java.
-
uri
String uri()Gets the uri- Returns:
- uri
- API:
- This public API is available in Java.
-
parent
ContentObject parent()Gets the parent content object or null if this content object is already the root.- Returns:
- parent of this content object
- API:
- This public API is available in Java.
-
isRoot
boolean isRoot()Whether this is the root content object or not.- Returns:
- true if this is the root content object otherwise false
- API:
- This public API is available in Java.
-
children
List<ContentObject> children()Gets all children of this content object.- Returns:
- all children
- API:
- This public API is available in Java.
-
child
ContentObjectChildAccessor child()Returns to the content object child accessory. To create and load child objects by name.- Returns:
- content object child accessory.
- API:
- This public API is available in Java.
-
values
List<ContentObjectValue> values()Gets all values of this content object.- Returns:
- content object values
- API:
- This public API is available in Java.
-
value
ContentObjectValueAccessor value()Gets the accessory for the content object values.- Returns:
- content object values accessory
- API:
- This public API is available in Java.
-
delete
void delete()Deletes this content object and all its children.- API:
- This public API is available in Java.
-
exists
boolean exists()If a content object exists or not.- Returns:
- true if it exists otherwise false
- API:
- This public API is available in Java.
-
meta
ContentObjectMeta meta()Returns the content object meta.- Returns:
- content object meta
- API:
- This public API is available in Java.
-
cms
ContentManagementSystem cms()Returns the content management system this content object belongs to.- Returns:
- content management system
- API:
- This public API is available in Java.
-