de.zib.gndms.common.dspace.service.SubspaceService Interface Reference

The interface of the Subspace service. More...

Inheritance diagram for de.zib.gndms.common.dspace.service.SubspaceService:

List of all members.

Public Member Functions
ResponseEntity< Facets >	createSubspace (String subspace, String config, String dn)
	Creates a subspace with the given configuration.
ResponseEntity< Specifier< Void > >	deleteSubspace (String subspace, String dn)
	Deletes a subspace.
ResponseEntity< List < Specifier< Void > > >	listSliceKinds (String subspace, String dn)
	Lists all available slice kinds.
ResponseEntity< List < Specifier< Void > > >	createSliceKind (String subspace, String sliceKind, String config, String dn)
	Create a slice kind.
ResponseEntity< Configuration >	listSubspaceConfiguration (String subspace, String dn)
	Lists a subspace configuration.
ResponseEntity< Void >	setSubspaceConfiguration (String subspace, Configuration config, String dn)
	Changes a subspace configuration.
ResponseEntity< Specifier< Void > >	createSlice (String subspace, String sliceKind, String config, String dn)
Package Functions
ResponseEntity< Facets >	listAvailableFacets (String subspace, String dn)
	Lists all facets of the subspace.

---

Detailed Description

The interface of the Subspace service.

Clients and resources which should provide the Subpace service should implement this interface.

Some general remarks on the parameters:

• The dn parameter is a identifier for the user responsible for the method invocation. It is required to check if the user has the necessary permissions for the call.
  Using REST the attribute should be provided using a http-header property called "DN".

Author:

Ulrike Golas

---

Member Function Documentation

ResponseEntity<List<Specifier<Void> > > de.zib.gndms.common.dspace.service.SubspaceService.createSliceKind	(	String	subspace,
		String	sliceKind,
		String	config,
		String	dn
	)

Create a slice kind.

Parameters:

subspace	The subspace identifier.
sliceKind	The sliceKind identifier.
dn	The dn of the user invoking the method.

Returns:

The list of slice kinds.

Implemented in de.zib.gndms.gndmc.dspace.SubspaceClient.

ResponseEntity<Facets> de.zib.gndms.common.dspace.service.SubspaceService.createSubspace	(	String	subspace,
		String	config,
		String	dn
	)

Creates a subspace with the given configuration.

Parameters:

subspace	The subspace identifier.
config	The subspace configuration.
dn	The dn of the user invoking the method.

Returns:

The facets of the created subspace.

Implemented in de.zib.gndms.gndmc.dspace.SubspaceClient.

ResponseEntity<Specifier<Void> > de.zib.gndms.common.dspace.service.SubspaceService.deleteSubspace	(	String	subspace,
		String	dn
	)

Deletes a subspace.

Parameters:

subspace	The subspace identifier.
dn	The dn of the user invoking the method.

Returns:

A confirmation.

ResponseEntity<Facets> de.zib.gndms.common.dspace.service.SubspaceService.listAvailableFacets	(	String	subspace,
		String	dn
	)		[package]

Lists all facets of the subspace.

Parameters:

subspace	The subspace identifier.
dn	The dn of the user invoking the method.

Returns:

The available facets.

ResponseEntity<List<Specifier<Void> > > de.zib.gndms.common.dspace.service.SubspaceService.listSliceKinds	(	String	subspace,
		String	dn
	)

Lists all available slice kinds.

Parameters:

subspace	The subspace identifier.
dn	The dn of the user invoking the method.

Returns:

The list of slice kinds.

ResponseEntity<Configuration> de.zib.gndms.common.dspace.service.SubspaceService.listSubspaceConfiguration	(	String	subspace,
		String	dn
	)

Lists a subspace configuration.

Parameters:

subspace	The subspace identifier.
dn	The dn of the user invoking the method.

Returns:

The subspace configuration.

ResponseEntity<Void> de.zib.gndms.common.dspace.service.SubspaceService.setSubspaceConfiguration	(	String	subspace,
		Configuration	config,
		String	dn
	)

Changes a subspace configuration.

Parameters:

subspace	The subspace identifier.
config	The subspace configuration.
dn	The dn of the user invoking the method.

Returns:

??.

---

The documentation for this interface was generated from the following file:

• common/src/de/zib/gndms/common/dspace/service/SubspaceService.java