Package org.ametys.plugins.repository
Interface AmetysObject
- All Known Subinterfaces:
ACLAmetysObject
,AttachableAmetysObject
,Calendar
,CalendarEvent
,CalendarResource
,CDMEntity
,CommentableContent
,CommentableResource
,Content
,ContributorCommentableContent
,CopiableAmetysObject
,DataAndVersionAwareAmetysObject
,DataAwareAmetysObject
,DublinCoreAwareAmetysObject
,ExplorerNode
,JCRAmetysObject
,JCRTraversableAmetysObject
,LockableAmetysObject
,LockAwareAmetysObject
,MetadataAwareAmetysObject
,MetadataAwareSitemapElement
,ModelAwareDataAwareAmetysObject
,ModelAwareDataAwareAmetysObject
,ModelAwareJCRAmetysObject
,ModelAwareJCRAmetysObject
,ModelLessDataAwareAmetysObject
,ModelLessJCRAmetysObject
,ModifiableACLAmetysObject
,ModifiableAmetysObject
,ModifiableCalendar
,ModifiableCalendarEvent
,ModifiableContent
,ModifiableDataAwareVersionableAmetysObject
,ModifiableDublinCoreAwareAmetysObject
,ModifiableExplorerNode
,ModifiableMetadataAwareAmetysObject
,ModifiableModelAwareDataAwareAmetysObject
,ModifiableModelAwareDataAwareAmetysObject
,ModifiableModelLessDataAwareAmetysObject
,ModifiablePage
,ModifiableResource
,ModifiableResourceCollection
,ModifiableSiteAwareAmetysObject
,ModifiableSitemapElement
,ModifiableThread
,ModifiableTraversableAmetysObject
,ModifiableWebContent
,ModifiableWorkflowAwareContent
,ModifiableZone
,ModifiableZoneItem
,MovableAmetysObject
,MoveablePage
,Page
,ProgramItem
,ProgramPart
,RemovableAmetysObject
,Resource
,ResourceCollection
,SharedContent
,SiteAwareAmetysObject
,SitemapElement
,TagAwareAmetysObject
,TaggableAmetysObject
,Task
,TasksList
,Thread
,Thread
,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
,Cart
,CartContainer
,Catalog
,CategoryJCR
,CMISResource
,CMISResourcesCollection
,CMISRootResourcesCollection
,CMSJCRTag
,ConfigurableVirtualZone
,ConfigurableVirtualZoneItem
,Container
,ContentBackupAmetysObject
,ContentConsistencyResult
,Course
,CourseList
,CoursePage
,CoursePart
,DefaultAlias
,DefaultAmetysObject
,DefaultContent
,DefaultDefinition
,DefaultLink
,DefaultLockableAmetysObject
,DefaultPage
,DefaultSharedContent
,DefaultTheme
,DefaultTraversableAmetysObject
,DefaultWebContent
,DefaultWorkflowAwareContent
,DefaultZone
,DefaultZoneItem
,FirstLevelPage
,Form
,FormDirectory
,FormEntry
,FormPage
,FormPageRule
,FormQuestion
,JCRCalendar
,JCRCalendarEvent
,JCRCalendarResource
,JCRCategory
,JCRPost
,JCRProjectMember
,JCRResource
,JCRResourcesCollection
,JCRTag
,JCRTask
,JCRTasksList
,JCRThread
,JCRThread
,KeywordJCR
,ModifiableDefaultContent
,ModifiableDefaultWebContent
,OrgUnit
,OrgUnitPage
,Person
,Program
,ProgramPage
,Project
,ProjectTagJCR
,Query
,QueryContainer
,RedirectPage
,RootAmetysObject
,SecondLevelPage
,SimpleAmetysObject
,Site
,Sitemap
,StaticZoneItem
,SubProgram
,Survey
,SurveyPage
,SurveyQuestion
,ThemeJCR
,Thesaurus
,TransitionalPage
,UGCPage
,UGCTransitionalPage
,UserPage
,UserZoneItem
,VersionAmetysObject
,VersionComponentAmetysObject
,VersionsAmetysObject
public interface AmetysObject
Common interface for all Ametys objects.
-
Method Summary
Modifier and TypeMethodDescriptionboolean
Two AmetysObjects are equals if and only if their ids are equals.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>
getName()
Retrieves the name of the current object.<A extends AmetysObject>
AReturns the parent object in the Ametys hierarchy.Returns the path of the parent object in the Ametys hierarchy.getPath()
Retrieves the path of the current object.int
hashCode()
The hashCode of an AmetysObject must be the hashCode of its id.
-
Method Details
-
getName
Retrieves the name of the current object.- Returns:
- the name.
- Throws:
AmetysRepositoryException
- if an error occurs.
-
getPath
Retrieves the path of the current object.- Returns:
- the path.
- Throws:
AmetysRepositoryException
- if an error occurs.
-
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>
- Returns:
- the unique identifier of this AmetysObject
- Throws:
AmetysRepositoryException
- if an error occurs.
-
getParent
Returns the parent object in the Ametys hierarchy.- Type Parameters:
A
- the type of the parentAmetysObject
.- Returns:
- the parent object or
null
if current object is the root. - Throws:
AmetysRepositoryException
- if an error occurs.
-
getParentPath
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
Two AmetysObjects are equals if and only if their ids are equals. -
hashCode
int hashCode()The hashCode of an AmetysObject must be the hashCode of its id.
-