org.ametys.plugins.repository

Interface AmetysObjectFactory<A extends AmetysObject>

Type Parameters:

A - the actual type of AmetysObjects

All Superinterfaces:

Component

All Known Subinterfaces:

JCRAmetysObjectFactory<A>, VirtualAmetysObjectFactory<A>

All Known Implementing Classes:

AmetysObjectCollectionFactory, BlogRootPageFactory, CartFactory, CatalogFactory, CategoryFactory, CMISTreeFactory, ContainerFactory, ContentFactory, CourseFactory, CourseListFactory, CoursePageFactory, CourseZoneFactory, CourseZoneItemFactory, DefaultAliasFactory, DefaultAmetysObjectFactory, DefaultDefinitionFactory, DefaultLinkFactory, DefaultLockableAmetysObjectFactory, DefaultPageFactory, DefaultSharedContentFactory, DefaultThemeFactory, DefaultTraversableAmetysObjectFactory, DefaultWebContentFactory, DefaultWorkflowAwareContentFactory, DefaultZoneFactory, DefaultZoneItemFactory, FirstLevelPageFactory, JCRCalendarEventFactory, JCRCalendarFactory, JCRPostFactory, JCRProjectMemberFactory, JCRResourceFactory, JCRResourcesCollectionFactory, JCRTaskFactory, JCRTasksListFactory, JCRThreadFactory, JCRWorkflowFactory, JCRWorkflowProcessFactory, MicroThesaurusFactory, ModifiableContentFactory, ModifiableDefaultWebContentFactory, OrgUnitFactory, OrgUnitPageFactory, OrgUnitZoneFactory, OrgUnitZoneItemFactory, PersonFactory, PostListZoneFactory, PostListZoneItemFactory, PostZoneFactory, PostZoneItemFactory, ProgramFactory, ProgramPageFactory, ProgramPartFactory, ProgramZoneFactory, ProgramZoneItemFactory, ProjectCategoryFactory, ProjectFactory, QueryFactory, RootAmetysObjectFactory, SecondLevelPageFactory, SimpleAmetysObjectFactory, SiteFactory, SitemapFactory, SubProgramFactory, SubscribersListFactory, SurveyFactory, SurveyPageFactory, SurveyQuestionFactory, TagFactory, ThesaurusFactory, TransitionalPageFactory, UserPageFactory, UserZoneFactory, UserZoneItemFactory, VirtualMonthPageFactory, VirtualOrganisationChartPageFactory, VirtualPostPageFactory, VirtualTagPageFactory, VirtualUserDirectoryPageFactory, VirtualYearPageFactory

public interface AmetysObjectFactory<A extends AmetysObject>
extends Component

Factory for retrieving type of AmetysObject.

Method Summary

Modifier and Type	Method and Description
A	getAmetysObjectById(String id) Retrieves an AmetysObject, given its id. Id are like <protocol>://<protocol-specific-part>.
String	getScheme() Returns the protocol of this factory, used to construct unique ids.
boolean	hasAmetysObjectForId(String id) Return true if the specified id correspond to an existing AmetysObject.

Method Detail

getAmetysObjectById

A getAmetysObjectById(String id)
               throws AmetysRepositoryException

Retrieves an AmetysObject, given its id.
Id are like <protocol>://<protocol-specific-part>.

Parameters:

id - the identifier.

Returns:

the corresponding AmetysObject.

Throws:

AmetysRepositoryException - if an error occurs.

hasAmetysObjectForId

boolean hasAmetysObjectForId(String id)
                      throws AmetysRepositoryException

Return true if the specified id correspond to an existing AmetysObject. Id are like <protocol>://<protocol-specific-part>.

Parameters:

id - the identifier.

Returns:

true if the specified id correspond to an existing AmetysObject.

Throws:

AmetysRepositoryException - if an error occurs.

getScheme

String getScheme()

Returns the protocol of this factory, used to construct unique ids.

Returns:

the protocol of this factory.