Uses of Interface
org.dspace.app.rest.projection.Projection

Packages that use Projection

Package	Description
org.dspace.app.rest
org.dspace.app.rest.converter
org.dspace.app.rest.model
org.dspace.app.rest.projection
org.dspace.app.rest.repository
org.dspace.app.rest.utils

Uses of Projection in org.dspace.app.rest

Methods in org.dspace.app.rest with parameters of type Projection

Modifier and Type	Method	Description
org.springframework.data.domain.Page<WorkflowActionRest>	WorkflowStepActionsLinkRepository.getActions(javax.servlet.http.HttpServletRequest request, String workflowStepName, org.springframework.data.domain.Pageable optionalPageable, Projection projection)	GET endpoint that returns the list of actions of a workflow step.
org.springframework.data.domain.Page<CollectionRest>	WorkflowDefinitionCollectionsLinkRepository.getCollections(javax.servlet.http.HttpServletRequest request, String workflowName, org.springframework.data.domain.Pageable optionalPageable, Projection projection)	GET endpoint that returns the list of collections that make an explicit use of the workflow-definition.
org.springframework.data.domain.Page<WorkflowStepRest>	WorkflowDefinitionStepsLinkRepository.getSteps(javax.servlet.http.HttpServletRequest request, String workflowName, org.springframework.data.domain.Pageable optionalPageable, Projection projection)	GET endpoint that returns the list of steps of a workflow-definition.

Uses of Projection in org.dspace.app.rest.converter

Methods in org.dspace.app.rest.converter that return Projection

Modifier and Type	Method	Description
Projection	ConverterService.getProjection(String projectionName)	Gets the projection with the given name, or the default (no-op) projection if null is given.

Methods in org.dspace.app.rest.converter with parameters of type Projection

Modifier and Type	Method	Description
void	DiscoverFacetsConverter.addFacetValues(org.dspace.core.Context context, org.dspace.discovery.DiscoverResult searchResult, SearchResultsRest resultsRest, org.dspace.discovery.configuration.DiscoveryConfiguration configuration, Projection projection)	Fill the facet values information in the SearchResultsRest using the information in the api DiscoverResult object according to the configuration applied to the discovery query
AuthenticationTokenRest	AuthenticationTokenConverter.convert(AuthenticationToken modelObject, Projection projection)
AuthorizationRest	AuthorizationConverter.convert(Authorization authz, Projection projection)
AuthorizationFeatureRest	AuthorizationFeatureConverter.convert(AuthorizationFeature feature, Projection projection)
BitstreamRest	BitstreamConverter.convert(org.dspace.content.Bitstream obj, Projection projection)
BitstreamFormatRest	BitstreamFormatConverter.convert(org.dspace.content.BitstreamFormat obj, Projection projection)
BrowseIndexRest	BrowseIndexConverter.convert(org.dspace.browse.BrowseIndex obj, Projection projection)
ClaimedTaskRest	ClaimedTaskConverter.convert(org.dspace.xmlworkflow.storedcomponents.ClaimedTask obj, Projection projection)
SearchConfigurationRest	DiscoverConfigurationConverter.convert(org.dspace.discovery.configuration.DiscoveryConfiguration configuration, Projection projection)
FacetResultsRest	DiscoverFacetResultsConverter.convert(org.dspace.core.Context context, String facetName, String prefix, String query, List<String> dsoTypes, String dsoScope, List<SearchFilter> searchFilters, org.dspace.discovery.DiscoverResult searchResult, org.dspace.discovery.configuration.DiscoveryConfiguration configuration, org.springframework.data.domain.Pageable page, Projection projection)
SearchResultsRest	DiscoverFacetsConverter.convert(org.dspace.core.Context context, String query, List<String> dsoTypes, String configurationName, String dsoScope, List<SearchFilter> searchFilters, org.springframework.data.domain.Pageable page, org.dspace.discovery.configuration.DiscoveryConfiguration configuration, org.dspace.discovery.DiscoverResult searchResult, Projection projection)
SearchFacetValueRest	DiscoverFacetValueConverter.convert(org.dspace.discovery.DiscoverResult.FacetResult value, Projection projection)
SearchResultsRest	DiscoverResultConverter.convert(org.dspace.core.Context context, String query, List<String> dsoTypes, String configurationName, String scope, List<SearchFilter> searchFilters, org.springframework.data.domain.Pageable page, org.dspace.discovery.DiscoverResult searchResult, org.dspace.discovery.configuration.DiscoveryConfiguration configuration, Projection projection)
R	DSpaceConverter.convert(M modelObject, Projection projection)
R	DSpaceObjectConverter.convert(M obj, Projection projection)
ParameterValueRest	DSpaceRunnableParameterConverter.convert(org.dspace.scripts.DSpaceCommandLineParameter dSpaceCommandLineParameter, Projection projection)
EntityTypeRest	EntityTypeConverter.convert(org.dspace.content.EntityType obj, Projection projection)
EPersonRest	EPersonConverter.convert(org.dspace.eperson.EPerson obj, Projection projection)
ExternalSourceEntryRest	ExternalSourceEntryRestConverter.convert(org.dspace.external.model.ExternalDataObject modelObject, Projection projection)
ExternalSourceRest	ExternalSourceRestConverter.convert(org.dspace.external.provider.ExternalDataProvider modelObject, Projection projection)
GroupRest	GroupConverter.convert(org.dspace.eperson.Group obj, Projection projection)
HarvestedCollectionRest	HarvestedCollectionConverter.convert(org.dspace.harvest.HarvestedCollection obj, Projection projection)
ItemRest	ItemConverter.convert(org.dspace.content.Item obj, Projection projection)
MetadataRest	MetadataConverter.convert(MetadataValueList metadataValues, Projection projection)
MetadataFieldRest	MetadataFieldConverter.convert(org.dspace.content.MetadataField obj, Projection projection)
MetadataSchemaRest	MetadataSchemaConverter.convert(org.dspace.content.MetadataSchema obj, Projection projection)
MetadataValueRest	MetadataValueConverter.convert(org.dspace.content.MetadataValue metadataValue, Projection projection)
PoolTaskRest	PoolTaskConverter.convert(org.dspace.xmlworkflow.storedcomponents.PoolTask obj, Projection projection)
ProcessRest	ProcessConverter.convert(org.dspace.scripts.Process process, Projection projection)
RelationshipRest	RelationshipConverter.convert(org.dspace.content.Relationship obj, Projection projection)
RelationshipTypeRest	RelationshipTypeConverter.convert(org.dspace.content.RelationshipType obj, Projection projection)
ResourcePolicyRest	ResourcePolicyConverter.convert(org.dspace.authorize.ResourcePolicy obj, Projection projection)
ScriptRest	ScriptConverter.convert(org.dspace.scripts.configuration.ScriptConfiguration scriptConfiguration, Projection projection)
SiteRest	SiteConverter.convert(org.dspace.content.Site obj, Projection projection)
SubmissionCCLicenseRest	SubmissionCCLicenseConverter.convert(org.dspace.license.CCLicense modelObject, Projection projection)	Convert a CCLicense to its REST representation
SubmissionCCLicenseFieldRest	SubmissionCCLicenseFieldConverter.convert(org.dspace.license.CCLicenseField modelObject, Projection projection)	Convert a CCLicenseField to its REST representation
SubmissionCCLicenseFieldEnumRest	SubmissionCCLicenseFieldEnumConverter.convert(org.dspace.license.CCLicenseFieldEnum modelObject, Projection projection)	Convert a CCLicenseFieldEnum to its REST representation
SubmissionCCLicenseUrlRest	SubmissionCCLicenseUrlConverter.convert(SubmissionCCLicenseUrl modelObject, Projection projection)	Convert a Submission CC License Url String to its REST representation
SubmissionDefinitionRest	SubmissionDefinitionConverter.convert(org.dspace.app.util.SubmissionConfig obj, Projection projection)
SubmissionFormRest	SubmissionFormConverter.convert(org.dspace.app.util.DCInputSet obj, Projection projection)
SubmissionSectionRest	SubmissionSectionConverter.convert(org.dspace.app.util.SubmissionStepConfig step, Projection projection)
TemplateItemRest	TemplateItemConverter.convert(TemplateItem templateItem, Projection projection)
UsageReportRest	UsageReportConverter.convert(UsageReportRest modelObject, Projection projection)
VersionRest	VersionConverter.convert(org.dspace.versioning.Version modelObject, Projection projection)
VersionHistoryRest	VersionHistoryConverter.convert(org.dspace.versioning.VersionHistory modelObject, Projection projection)
VocabularyEntryDetailsRest	VocabularyEntryDetailsRestConverter.convert(org.dspace.content.authority.Choice choice, Projection projection)
VocabularyRest	VocabularyRestConverter.convert(org.dspace.content.authority.ChoiceAuthority authority, Projection projection)
WorkflowActionRest	WorkflowActionConverter.convert(org.dspace.xmlworkflow.state.actions.WorkflowActionConfig modelObject, Projection projection)
WorkflowDefinitionRest	WorkflowDefinitionConverter.convert(org.dspace.xmlworkflow.state.Workflow modelObject, Projection projection)
WorkflowItemRest	WorkflowItemConverter.convert(org.dspace.xmlworkflow.storedcomponents.XmlWorkflowItem obj, Projection projection)
WorkflowStepRest	WorkflowStepConverter.convert(org.dspace.xmlworkflow.state.Step modelObject, Projection projection)
WorkspaceItemRest	WorkspaceItemConverter.convert(org.dspace.content.WorkspaceItem obj, Projection projection)
protected void	AInprogressItemConverter.fillFromModel(T obj, R witem, Projection projection)
HarvestedCollectionRest	HarvestedCollectionConverter.fromModel(org.dspace.harvest.HarvestedCollection obj, org.dspace.content.Collection collection, List<Map<String,String>> metadata_configs, Projection projection)
<M,R> R	ConverterService.toRest(M modelObject, Projection projection)	Converts the given model object to a rest object, using the appropriate DSpaceConverter and the given projection.
<M,R> org.springframework.data.domain.Page<R>	ConverterService.toRestPage(List<M> modelObjects, org.springframework.data.domain.Pageable pageable, long total, Projection projection)	Converts a list of ModelObjects to a page of Rest Objects using the given Projection This method differences in the sense that we define a total here instead of the size of the list because this method will be called if the list is limited through a DB call already and thus we need to give the total amount of records in the DB; not the size of the given list
<M,R> org.springframework.data.domain.Page<R>	ConverterService.toRestPage(List<M> modelObjects, org.springframework.data.domain.Pageable pageable, Projection projection)	Converts a list of model objects to a page of rest objects using the given Projection.

Uses of Projection in org.dspace.app.rest.model

Methods in org.dspace.app.rest.model that return Projection

Modifier and Type	Method	Description
Projection	RestAddressableModel.getProjection()

Methods in org.dspace.app.rest.model with parameters of type Projection

Modifier and Type	Method	Description
void	RestAddressableModel.setProjection(Projection projection)

Uses of Projection in org.dspace.app.rest.projection

Classes in org.dspace.app.rest.projection that implement Projection

Modifier and Type	Class	Description
class	AbstractProjection	Abstract base class for projections.
class	CompositeProjection	A projection that combines the behavior of multiple projections.
class	DefaultProjection	The default projection.
class	EmbedRelsProjection	Projection that allows a given set of rels to be embedded.
class	FullProjection	Catch-all projection that allows embedding of all subresources.
class	SpecificLevelProjection	This Projection will allow us to specify how many levels deep we're going to embed resources onto the requested HalResource.

Fields in org.dspace.app.rest.projection declared as Projection

Modifier and Type	Field	Description
static Projection	Projection.DEFAULT	The default projection.

Constructor parameters in org.dspace.app.rest.projection with type arguments of type Projection

Constructor	Description
CompositeProjection(List<Projection> projections)

Uses of Projection in org.dspace.app.rest.repository

Methods in org.dspace.app.rest.repository with parameters of type Projection

Modifier and Type	Method	Description
org.springframework.data.domain.Page<VocabularyEntryRest>	VocabularyEntryLinkRepository.filter(javax.servlet.http.HttpServletRequest request, String name, org.springframework.data.domain.Pageable optionalPageable, Projection projection)
GroupRest	CollectionAdminGroupLinkRepository.getAdminGroup(javax.servlet.http.HttpServletRequest request, UUID collectionId, org.springframework.data.domain.Pageable optionalPageable, Projection projection)	This method is responsible for retrieving the AdminGroup of a Collection
GroupRest	CommunityAdminGroupLinkRepository.getAdminGroup(javax.servlet.http.HttpServletRequest request, UUID communityId, org.springframework.data.domain.Pageable optionalPageable, Projection projection)	This method is responsible for retrieving the AdminGroup of a Community
GroupRest	CollectionBitstreamReadGroupLinkRepository.getBitstreamReadGroup(javax.servlet.http.HttpServletRequest request, UUID collectionId, org.springframework.data.domain.Pageable optionalPageable, Projection projection)	This method is responsible for retrieving the BitstreamReadGroup of a Collection
org.springframework.data.domain.Page<BitstreamRest>	BundleBitstreamLinkRepository.getBitstreams(javax.servlet.http.HttpServletRequest request, UUID bundleId, org.springframework.data.domain.Pageable optionalPageable, Projection projection)
BundleRest	BitstreamBundleLinkRepository.getBundle(javax.servlet.http.HttpServletRequest request, UUID bitstreamId, org.springframework.data.domain.Pageable optionalPageable, Projection projection)
org.springframework.data.domain.Page<BundleRest>	ItemBundleLinkRepository.getBundles(javax.servlet.http.HttpServletRequest request, UUID itemId, org.springframework.data.domain.Pageable optionalPageable, Projection projection)
org.springframework.data.domain.Page<VocabularyEntryDetailsRest>	VocabularyEntryDetailsChildrenLinkRepository.getChildren(javax.servlet.http.HttpServletRequest request, String name, org.springframework.data.domain.Pageable optionalPageable, Projection projection)
org.springframework.data.domain.Page<CollectionRest>	CommunityCollectionLinkRepository.getCollections(javax.servlet.http.HttpServletRequest request, UUID communityId, org.springframework.data.domain.Pageable optionalPageable, Projection projection)
EPersonRest	AuthorizationEpersonLinkRepository.getEperson(javax.servlet.http.HttpServletRequest request, String authzId, org.springframework.data.domain.Pageable optionalPageable, Projection projection)
AuthorizationFeatureRest	AuthorizationFeatureLinkRepository.getFeature(javax.servlet.http.HttpServletRequest request, String authzId, org.springframework.data.domain.Pageable optionalPageable, Projection projection)
org.springframework.data.domain.Page<BitstreamRest>	ProcessFilesLinkRepository.getFilesFromProcess(javax.servlet.http.HttpServletRequest request, Integer processId, org.springframework.data.domain.Pageable optionalPageable, Projection projection)	This method will retrieve all the files from the process
ProcessFileTypesRest	ProcessFileTypesLinkRepository.getFileTypesFromProcess(javax.servlet.http.HttpServletRequest request, Integer processId, org.springframework.data.domain.Pageable optionalPageable, Projection projection)	This will be the admin only endpoint that returns the ProcessFileTypesRest constructed with the values found in the Bitstreams of the Process with the given ProcessId
BitstreamFormatRest	BitstreamFormatLinkRepository.getFormat(javax.servlet.http.HttpServletRequest request, UUID bitstreamId, org.springframework.data.domain.Pageable optionalPageable, Projection projection)
org.springframework.data.domain.Page<GroupRest>	EPersonGroupLinkRepository.getGroups(javax.servlet.http.HttpServletRequest request, UUID epersonId, org.springframework.data.domain.Pageable optionalPageable, Projection projection)
org.springframework.data.domain.Page<GroupRest>	GroupGroupLinkRepository.getGroups(javax.servlet.http.HttpServletRequest request, UUID groupId, org.springframework.data.domain.Pageable optionalPageable, Projection projection)
ItemRest	BundleItemLinkRepository.getItem(javax.servlet.http.HttpServletRequest request, UUID bundleId, org.springframework.data.domain.Pageable optionalPageable, Projection projection)	Get the item where the provided bundle resides in
GroupRest	CollectionItemReadGroupLinkRepository.getItemReadGroup(javax.servlet.http.HttpServletRequest request, UUID collectionId, org.springframework.data.domain.Pageable optionalPageable, Projection projection)	This method is responsible for retrieving the ItemReadGroup of a Collection
VersionRest	ItemVersionLinkRepository.getItemVersion(javax.servlet.http.HttpServletRequest request, UUID itemUuid, org.springframework.data.domain.Pageable optionalPageable, Projection projection)	This method will return the VersionRest object from the Item that is associated with the given itemUuid
LicenseRest	CollectionLicenseLinkRepository.getLicense(javax.servlet.http.HttpServletRequest request, UUID collectionId, org.springframework.data.domain.Pageable pageable, Projection projection)
BitstreamRest	CollectionLogoLinkRepository.getLogo(javax.servlet.http.HttpServletRequest request, UUID collectionId, org.springframework.data.domain.Pageable optionalPageable, Projection projection)
BitstreamRest	CommunityLogoLinkRepository.getLogo(javax.servlet.http.HttpServletRequest request, UUID communityId, org.springframework.data.domain.Pageable optionalPageable, Projection projection)
org.springframework.data.domain.Page<CollectionRest>	ItemMappedCollectionLinkRepository.getMappedCollections(javax.servlet.http.HttpServletRequest request, UUID itemId, org.springframework.data.domain.Pageable optionalPageable, Projection projection)
org.springframework.data.domain.Page<ItemRest>	CollectionMappedItemLinkRepository.getMappedItems(javax.servlet.http.HttpServletRequest request, UUID collectionId, org.springframework.data.domain.Pageable optionalPageable, Projection projection)
org.springframework.data.domain.Page<GroupRest>	GroupEPersonLinkRepository.getMembers(javax.servlet.http.HttpServletRequest request, UUID groupId, org.springframework.data.domain.Pageable optionalPageable, Projection projection)
BaseObjectRest	AuthorizationObjectLinkRepository.getObject(javax.servlet.http.HttpServletRequest request, String authzId, org.springframework.data.domain.Pageable optionalPageable, Projection projection)
BitstreamRest	ProcessOutputLinkRepository.getOutputFromProcess(javax.servlet.http.HttpServletRequest request, Integer processId, org.springframework.data.domain.Pageable optionalPageable, Projection projection)	This method will retrieve the output for the Process as defined through the given ID in the rest call.
CollectionRest	ItemOwningCollectionLinkRepository.getOwningCollection(javax.servlet.http.HttpServletRequest request, UUID itemId, org.springframework.data.domain.Pageable optionalPageable, Projection projection)
VocabularyEntryDetailsRest	VocabularyEntryDetailsParentLinkRepository.getParent(javax.servlet.http.HttpServletRequest request, String name, org.springframework.data.domain.Pageable optionalPageable, Projection projection)
CommunityRest	CollectionParentCommunityLinkRepository.getParentCommunity(javax.servlet.http.HttpServletRequest httpServletRequest, UUID collectionId, org.springframework.data.domain.Pageable optionalPageable, Projection projection)	This method retrieves the ParentCommunity object for the Collection which is defined by the given collectionId It'll transform this Parent Community to a REST object and return this
CommunityRest	CommunityParentCommunityLinkRepository.getParentCommunity(javax.servlet.http.HttpServletRequest httpServletRequest, UUID communityId, org.springframework.data.domain.Pageable optionalPageable, Projection projection)	This method retrieves the ParentCommunity object for the Community which is defined by the given communityId It'll transform this Parent Community to a REST object and return this
DSpaceObjectRest	GroupParentObjectLinkRepository.getParentObject(javax.servlet.http.HttpServletRequest request, UUID groupId, org.springframework.data.domain.Pageable optionalPageable, Projection projection)	This returns the DSpace Object (Community, Collection) belonging to this Group.
BitstreamRest	BundlePrimaryBitstreamLinkRepository.getPrimaryBitstream(javax.servlet.http.HttpServletRequest request, UUID bundleId, org.springframework.data.domain.Pageable optionalPageable, Projection projection)
org.springframework.data.domain.Page<RelationshipRest>	ItemRelationshipLinkRepository.getRelationships(javax.servlet.http.HttpServletRequest request, UUID itemId, org.springframework.data.domain.Pageable optionalPageable, Projection projection)
BitstreamRest	ProcessFilesLinkRepository.getResource(javax.servlet.http.HttpServletRequest request, String processId, String fileType, org.springframework.data.domain.Pageable pageable, Projection projection)	This method will retrieve a bitstream for the given processId for the given fileType
SearchResultsRest	DiscoveryRestRepository.getSearchObjects(String query, List<String> dsoTypes, String dsoScope, String configuration, List<SearchFilter> searchFilters, org.springframework.data.domain.Pageable page, Projection projection)
WorkflowStepRest	ClaimedTaskStepLinkRepository.getStep(javax.servlet.http.HttpServletRequest request, Integer claimedTaskId, org.springframework.data.domain.Pageable optionalPageable, Projection projection)	This method will retrieve the WorkflowStepRest object for the ClaimedTask with the given id
WorkflowStepRest	PoolTaskStepLinkRepository.getStep(javax.servlet.http.HttpServletRequest request, Integer poolTaskId, org.springframework.data.domain.Pageable optionalPageable, Projection projection)	This method will retrieve the WorkflowStepRest object for the PoolTask with the given id
WorkflowStepRest	WorkflowItemStepLinkRepository.getStep(javax.servlet.http.HttpServletRequest request, Integer workflowItemId, org.springframework.data.domain.Pageable optionalPageable, Projection projection)	This method will retrieve the WorkflowStepRest object for the WorkflowItem with the given id
org.springframework.data.domain.Page<CommunityRest>	CommunitySubcommunityLinkRepository.getSubcommunities(javax.servlet.http.HttpServletRequest request, UUID communityId, org.springframework.data.domain.Pageable optionalPageable, Projection projection)
GroupRest	CollectionSubmitterGroupLinkRepository.getSubmittersGroup(javax.servlet.http.HttpServletRequest request, UUID collectionId, org.springframework.data.domain.Pageable optionalPageable, Projection projection)	This method is responsible for retrieving the Submittergroup of a Collection
CollectionRest	ItemTemplateItemOfLinkRepository.getTemplateItemOf(javax.servlet.http.HttpServletRequest request, UUID itemId, org.springframework.data.domain.Pageable optionalPageable, Projection projection)
VersionHistoryRest	VersionHistoryLinkRepository.getVersionHistory(javax.servlet.http.HttpServletRequest request, Integer versionId, org.springframework.data.domain.Pageable optionalPageable, Projection projection)	This method will retrieve the VersionHistoryRest object from the Version that is found by the associated versionId parameter
ItemRest	VersionItemLinkRepository.getVersionItem(javax.servlet.http.HttpServletRequest request, Integer versionId, org.springframework.data.domain.Pageable optionalPageable, Projection projection)	This method will return the ItemRest object constructed from the Item object which is found in the Version that will be found through the versionId parameter
org.springframework.data.domain.Page<VersionRest>	VersionsLinkRepository.getVersions(javax.servlet.http.HttpServletRequest request, Integer versionHistoryId, org.springframework.data.domain.Pageable optionalPageable, Projection projection)	This method will return a page of VersionRest objects found through the VersionHistory object that is resolved from the versionHistoryId parameter
org.springframework.data.domain.Page<BrowseEntryRest>	BrowseEntryLinkRepository.listBrowseEntries(javax.servlet.http.HttpServletRequest request, String browseName, org.springframework.data.domain.Pageable pageable, Projection projection)
org.springframework.data.domain.Page<ItemRest>	BrowseItemLinkRepository.listBrowseItems(javax.servlet.http.HttpServletRequest request, String browseName, org.springframework.data.domain.Pageable pageable, Projection projection)

Uses of Projection in org.dspace.app.rest.utils

Methods in org.dspace.app.rest.utils that return Projection

Modifier and Type	Method	Description
Projection	Utils.obtainProjection()	Gets the effective projection requested by the current servlet request, or DefaultProjection if none is specified.

Methods in org.dspace.app.rest.utils with parameters of type Projection

Modifier and Type	Method	Description
VocabularyRest	AuthorityUtils.convertAuthority(org.dspace.content.authority.ChoiceAuthority source, String authorityName, Projection projection)	TODO the authorityName MUST be a part of ChoiceAuthority model
VocabularyEntryRest	AuthorityUtils.convertEntry(org.dspace.content.authority.Choice choice, String authorityName, boolean storeAuthority, Projection projection)	This utility method is currently a workaround to enrich the REST object with information from the parent vocabulary that is not referenced by the Choice model
VocabularyEntryDetailsRest	AuthorityUtils.convertEntryDetails(org.dspace.content.authority.Choice choice, String authorityName, boolean isHierarchical, Projection projection)	TODO the authorityName MUST be a part of Choice model