SpaceService

Abstract Value Members

abstract def addCollection(collection: UUID, space: UUID): Unit
abstract def addDataset(dataset: UUID, space: UUID): Unit
abstract def addFollower(id: UUID, userId: UUID): Unit

Add follower to a file.
abstract def addUser(user: UUID, role: Role, space: UUID): Unit

Add a user to the space, along with an associated role.
Add a user to the space, along with an associated role.
user
The identifier for the user that is to be added to the space
role
The role that is to be assigned to the user in the context of this space
space
The identifier for the space that the user is being added to
abstract def changeUserRole(userId: UUID, role: Role, space: UUID): Unit

Update a user's role within a space.
Update a user's role within a space.
userId
The identifier of the user to be updated
role
The new role to be assigned to the user in the space
space
The identifier of the space to be updated
abstract def count(filter: Option[String] = None): Long

The number of objects that are available based on the filter
The number of objects that are available based on the filter

Definition Classes
CRUDService
abstract def delete(id: UUID): Unit

Definition Classes
CRUDService
abstract def get(id: UUID): Option[ProjectSpace]

Definition Classes
CRUDService
abstract def getCollectionsInSpace(space: Option[String] = None, order: Option[String] = None, limit: Option[Integer] = None): List[Collection]

Service access to retrieve a list of collections in a given space, of prescribed list length.
Service access to retrieve a list of collections in a given space, of prescribed list length.
space
Identifies the space.
order
Sort order (if any) by created date
limit
Length of (the number of collections in) returned list.
returns
A list of collections in a space; list's length is defined by 'limit'.
abstract def getDatasetsInSpace(space: Option[String] = None, order: Option[String] = None, limit: Option[Integer] = None): List[Dataset]

Service access to retrieve a list of datasets in a given space, of prescribed list length.
Service access to retrieve a list of datasets in a given space, of prescribed list length.
space
Identifies the space.
order
Sort order (if any) by created date
limit
Length of (the number of datasets in) returned list.
returns
A list of datasets in a space; list's length is defined by 'limit'.
abstract def getNext(order: Option[String], direction: Direction, start: Date, limit: Integer = 20, filter: Option[String]): Option[String]

Return the start that should be used for the list operation to get the next set of items based on the give parameters.
Return the start that should be used for the list operation to get the next set of items based on the give parameters. This will return None if there are no more items (i.e. last page).
order
the key to use to order the data, default is natural ordering of underlying implementation
direction
the direction to order the data in
start
the first element that should be returned based on the order key
limit
the maximum number of elements to return in a page
filter
is a json representation of the filter to be applied

Definition Classes
CRUDService
abstract def getPrev(order: Option[String], direction: Direction, start: Date, limit: Integer = 20, filter: Option[String]): Option[String]

Return the start that should be used for the list operation to get the prev set of items based on the give parameters.
Return the start that should be used for the list operation to get the prev set of items based on the give parameters. This will return None if there are no more items (i.e. first page).
order
the key to use to order the data, default is natural ordering of underlying implementation
direction
the direction to order the data in
start
the first element that should be returned based on the order key
limit
the maximum number of elements to return in a page
filter
is a json representation of the filter to be applied

Definition Classes
CRUDService
abstract def getRoleForUserInSpace(spaceId: UUID, userId: UUID): Option[Role]

Retrieve the role associated to a user for a given space.
Retrieve the role associated to a user for a given space.
spaceId
The identifier of the space to get data for
userId
The identifier of the user to retrieve data for within the space
returns
The role that a specific user has within the specified space
abstract def getTimeToLive(space: UUID): Long

Obtain the time to live for resources that are assigned to a specific space.
Obtain the time to live for resources that are assigned to a specific space.
space
The identifier for the space to be queried
returns
The length of time, in milliseconds, that resources are allowed to persist in this space.
abstract def getUsersInSpace(spaceId: UUID): List[User]

Retrieve the users that are associated with a specific space.
Retrieve the users that are associated with a specific space.
spaceId
The identifier of the space to retrieve user data from
returns
A list that contains all of the users that are associated with a specific space
abstract def insert(model: ProjectSpace): Option[String]

Definition Classes
CRUDService
abstract def isTimeToLiveEnabled(space: UUID): Boolean

Determine if time to live for resources is enabled for a specific space.
Determine if time to live for resources is enabled for a specific space.
space
The identifier for the space that is being checked
returns
A flag that denotes if time to live is enabled on this space.
abstract def list(order: Option[String] = None, direction: Direction = DESC, start: Option[String] = None, limit: Integer = 20, filter: Option[String] = None): List[ProjectSpace]

Return a list objects that are available based on the filter as well as the other options.
Return a list objects that are available based on the filter as well as the other options.
order
the key to use to order the data, default is natural ordering of underlying implementation
direction
the direction to order the data in
start
the first element that should be returned based on the order key
limit
the maximum number of elements to return in a page
filter
is a json representation of the filter to be applied

Definition Classes
CRUDService
abstract def purgeExpiredResources(space: UUID): Unit

Service call to tell a space to clean up resources that are expired relative to the specified time to live.
Service call to tell a space to clean up resources that are expired relative to the specified time to live.
space
The identifier for the space that will be purged
abstract def removeFollower(id: UUID, userId: UUID): Unit

Remove follower from a file.
abstract def removeUser(userId: UUID, space: UUID): Unit

Remove a user from the space.
Remove a user from the space.
space
The identifier for the space that the user is being removed from
abstract def update(model: ProjectSpace): Unit

Definition Classes
CRUDService
abstract def updateSpaceConfiguration(spaceId: UUID, name: String, description: String, timeToLive: Long, expireEnabled: Boolean): Unit

Service call to update the information and configuration that are part of a space.
Service call to update the information and configuration that are part of a space.
spaceId
The identifier for the space to be updated
name
The updated name information, HTMLEncoded since it is free text
description
The updated description information, HTMLEncoded since it is free text
expireEnabled
The updated flag, indicating whether or not the space should allow resources to expire

Concrete Value Members

final def !=(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def !=(arg0: Any): Boolean

Definition Classes
Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def ==(arg0: Any): Boolean

Definition Classes
Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

trait SpaceService extends CRUDService[ProjectSpace]

Abstract Value Members

abstract def addCollection(collection: UUID, space: UUID): Unit

abstract def addDataset(dataset: UUID, space: UUID): Unit

abstract def addFollower(id: UUID, userId: UUID): Unit

abstract def addUser(user: UUID, role: Role, space: UUID): Unit

abstract def changeUserRole(userId: UUID, role: Role, space: UUID): Unit

abstract def count(filter: Option[String] = None): Long

abstract def delete(id: UUID): Unit

abstract def get(id: UUID): Option[ProjectSpace]

abstract def getCollectionsInSpace(space: Option[String] = None, order: Option[String] = None, limit: Option[Integer] = None): List[Collection]

abstract def getDatasetsInSpace(space: Option[String] = None, order: Option[String] = None, limit: Option[Integer] = None): List[Dataset]

abstract def getNext(order: Option[String], direction: Direction, start: Date, limit: Integer = 20, filter: Option[String]): Option[String]

abstract def getPrev(order: Option[String], direction: Direction, start: Date, limit: Integer = 20, filter: Option[String]): Option[String]

abstract def getRoleForUserInSpace(spaceId: UUID, userId: UUID): Option[Role]

abstract def getTimeToLive(space: UUID): Long

abstract def getUsersInSpace(spaceId: UUID): List[User]

abstract def insert(model: ProjectSpace): Option[String]

abstract def isTimeToLiveEnabled(space: UUID): Boolean

abstract def list(order: Option[String] = None, direction: Direction = DESC, start: Option[String] = None, limit: Integer = 20, filter: Option[String] = None): List[ProjectSpace]

abstract def purgeExpiredResources(space: UUID): Unit

abstract def removeFollower(id: UUID, userId: UUID): Unit

abstract def removeUser(userId: UUID, space: UUID): Unit

abstract def update(model: ProjectSpace): Unit

abstract def updateSpaceConfiguration(spaceId: UUID, name: String, description: String, timeToLive: Long, expireEnabled: Boolean): Unit

Concrete Value Members

final def !=(arg0: AnyRef): Boolean

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: AnyRef): Boolean

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from CRUDService[ProjectSpace]

Inherited from AnyRef

Inherited from Any

Ungrouped