Package org.ametys.plugins.repository

Interface AmetysObject

All Superinterfaces:

DataHolder

All Known Subinterfaces:

ACLAmetysObject, AttachableAmetysObject, CalendarEvent, CalendarResource, CDMEntity, CommentableAmetysObject<T>, CommentableContent, Content, ContributorCommentableContent, CopiableAmetysObject, DataAndVersionAwareAmetysObject, DublinCoreAwareAmetysObject, ExplorerNode, IndexableAmetysObject, IndexableJCRAmetysObject, JCRAmetysObject, JCRTraversableAmetysObject, LockableAmetysObject, LockablePage, LockAwareAmetysObject, MetadataAwareAmetysObject, ModelAwareAmetysObject, ModelAwareJCRAmetysObject, ModifiableACLAmetysObject, ModifiableAmetysObject, ModifiableCalendarEvent, ModifiableContent, ModifiableDataAwareVersionableAmetysObject, ModifiableDublinCoreAwareAmetysObject, ModifiableExplorerNode, ModifiableIndexableAmetysObject, ModifiableMetadataAwareAmetysObject, ModifiableModelAwareAmetysObject, ModifiablePage, ModifiableResource, ModifiableResourceCollection, ModifiableSiteAwareAmetysObject, ModifiableSitemapElement, ModifiableTraversableAmetysObject, ModifiableWebContent, ModifiableWorkflowAwareContent, ModifiableZone, ModifiableZoneItem, MovableAmetysObject, MoveablePage, Page, ProgramItem, ProgramPart, RemovableAmetysObject, Resource, ResourceCollection, SharedContent, SiteAwareAmetysObject, SitemapElement, TagAwareAmetysObject, TaggableAmetysObject, Task, TasksList, Thread, TrashableAmetysObject, TrashElement, TraversableAmetysObject, TraversableProgramPart, VersionableAmetysObject, VersionAwareAmetysObject, WebContent, WorkflowAwareAmetysObject, WorkflowAwareContent, Zone, ZoneItem

All Known Implementing Classes:

AbstractAmetysObject, AbstractColorableJCRTag, AbstractConfigurableVirtualPage, AbstractOdfPage, AbstractProgram, AbstractProgramItemPage, AbstractProgramPart, AbstractSitemapElement, AbstractSurveyElement, AbstractTraversableProgramPart, Activity, AmetysObjectCollection, CacheContentVersionChunk, Cart, CartContainer, Catalog, CategoryJCR, CMISResource, CMISResourcesCollection, CMISRootResourcesCollection, CMSJCRTag, ConfigurableVirtualZone, ConfigurableVirtualZoneItem, Container, ContentBackupAmetysObject, ContentConsistencyResult, Course, CourseList, CoursePage, CoursePart, DefaultAlias, DefaultAmetysObject, DefaultContent, DefaultDefinition, DefaultIndexableAmetysObject, DefaultIndexableTraversableAmetysObject, DefaultLink, DefaultLockableAmetysObject, DefaultPage, DefaultSharedContent, DefaultTheme, DefaultTheme, DefaultTrashElement, DefaultTraversableAmetysObject, DefaultWebContent, DefaultWorkflowAwareContent, DefaultZone, DefaultZoneItem, File, FirstLevelPage, Folder, Form, FormDirectory, FormEntry, FormPage, FormPageRule, FormQuestion, JCRCalendar, JCRCalendarEvent, JCRCalendarResource, JCRCategory, JCRProjectMember, JCRResource, JCRResourcesCollection, JCRTag, JCRTask, JCRTasksList, JCRThread, KeywordJCR, ModifiableDefaultContent, ModifiableDefaultWebContent, OrgUnit, OrgUnitPage, Person, Program, ProgramPage, Project, ProjectTagJCR, Query, QueryContainer, RedirectPage, RootAmetysObject, SecondLevelPage, SimpleAmetysObject, SimpleIndexableAmetysObject, SimpleModelAwareAmetysObject, Site, Sitemap, StaticZoneItem, SubProgram, Subscription, Survey, SurveyPage, SurveyQuestion, TaskCalendarEvent, ThemeJCR, ThemeJCR, Thesaurus, TransitionalPage, UGCPage, UGCTransitionalPage, UserPage, UserZoneItem, VersionAmetysObject, VersionComponentAmetysObject, VersionsAmetysObject

public interface AmetysObject
extends DataHolder

Common interface for all Ametys objects.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)	Two AmetysObjects are equals if and only if their ids are equals.
String	getId()	Retrieves the unique identifier of this AmetysObject. It must be unique in the whole repository and must never be null. It must conform to the URI syntax: <protocol>://<protocol-specific-part>
String	getName()	Retrieves the name of the current object.
<A extends AmetysObject> A	getParent()	Returns the parent object in the Ametys hierarchy.
String	getParentPath()	Returns the path of the parent object in the Ametys hierarchy.
String	getPath()	Retrieves the path of the current object.
int	hashCode()	The hashCode of an AmetysObject must be the hashCode of its id.

Methods inherited from interface org.ametys.plugins.repository.data.holder.DataHolder

copyTo, copyTo, dataToJSON, dataToJSON, dataToJSON, dataToJSON, dataToSAX, dataToSAX, dataToSAX, dataToSAX, getComposite, getDataNames, getModelItemTypeExtensionPoint, getParentDataHolder, getRepositoryData, getRootDataHolder, getType, getValue, getValueOfType, getValueOfTypeOrDefault, getValueOrDefault, hasDifferences, hasValue, hasValue, hasValueOrEmpty, isMultiple, isMultiple

Method Details

getName

String getName()
        throws AmetysRepositoryException

Retrieves the name of the current object.

Returns:

the name.

Throws:

AmetysRepositoryException - if an error occurs.

getPath

String getPath()
        throws AmetysRepositoryException

Retrieves the path of the current object.

Returns:

the path.

Throws:

AmetysRepositoryException - if an error occurs.

getId

String getId()
      throws AmetysRepositoryException

Retrieves the unique identifier of this AmetysObject.
It must be unique in the whole repository and must never be null.
It must conform to the URI syntax:
<protocol>://<protocol-specific-part>

Returns:

the unique identifier of this AmetysObject

Throws:

AmetysRepositoryException - if an error occurs.

getParent

<A extends AmetysObject> A getParent()
                              throws AmetysRepositoryException

Returns the parent object in the Ametys hierarchy.

Type Parameters:

A - the type of the parent AmetysObject.

Returns:

the parent object or null if current object is the root.

Throws:

AmetysRepositoryException - if an error occurs.

getParentPath

String getParentPath()
              throws AmetysRepositoryException

Returns the path of the parent object in the Ametys hierarchy.

Returns:

the path of the parent object.

Throws:

AmetysRepositoryException - if an error occurs.

equals

boolean equals(Object obj)

Two AmetysObjects are equals if and only if their ids are equals.

Overrides:

equals in class Object

hashCode

int hashCode()

The hashCode of an AmetysObject must be the hashCode of its id.

Overrides:

hashCode in class Object