services

SpaceService

trait SpaceService extends AnyRef

Service to manipulate spaces.

Linear Supertypes
AnyRef, Any
Known Subclasses
MongoDBSpaceService
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. SpaceService
  2. AnyRef
  3. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def addCollection(collection: UUID, space: UUID, user: Option[User]): Unit

  2. abstract def addCurationObject(spaceId: UUID, curationObjectId: UUID): Unit

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

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

    Add follower to a file.

  5. abstract def addInvitationToSpace(invite: SpaceInvite): Unit

    Add Invitation to a Space

  6. abstract def addRequest(id: UUID, userId: UUID, username: String): Unit

    Add authorization request to a space.

  7. 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

  8. 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

  9. abstract def count(): Long

    Count all spaces

  10. abstract def countAccess(permisions: Set[Permission], user: Option[User], showAll: Boolean): Long

    Return a count of spaces the user has access to.

  11. abstract def countUser(user: Option[User], showAll: Boolean, owner: User): Long

    Return a count of spaces the user has created.

  12. abstract def decrementCollectionCounter(collection: UUID, space: UUID, decrement: Int): Unit

  13. abstract def decrementFileCounter(space: UUID, decrement: Long): Unit

  14. abstract def decrementSpaceBytes(space: UUID, decrement: Long): Unit

  15. abstract def delete(id: UUID, host: String, apiKey: Option[String], user: Option[User]): Unit

    delete given space.

  16. abstract def deleteAllExtractors(spaceId: UUID): Boolean

    Delete an entire entry with extractors for this space id.

  17. abstract def disableExtractor(spaceId: UUID, extractor: String): Unit

    Disable extractors within the space.

    Disable extractors within the space. This is used to override global selections.

    spaceId
    extractor

  18. abstract def enableExtractor(spaceId: UUID, extractor: String): Unit

    If entry for spaceId already exists, will update list of extractors.

    If entry for spaceId already exists, will update list of extractors. Otherwise will create and add a new document to the collection, with spaceId and extractor given.

  19. abstract def get(ids: List[UUID]): DBResult[ProjectSpace]

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

    return space with specific id

  21. abstract def getAllExtractors(spaceId: UUID): Option[ExtractorsForSpace]

    Get all extractors for this space id.

    Get all extractors for this space id. This is the union of all enabled and disabled extractors for this space. If a user never manually enabled or disabled an extractor for a space it will not be returned, but the extractor might still be enabled/disabled at the instance level.

  22. abstract def getCollectionsInSpace(space: 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.

    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'.

  23. abstract def getDatasetsInSpace(space: 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.

    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'.

  24. abstract def getInvitation(inviteId: String): Option[SpaceInvite]

    Find an invitation by ID

  25. abstract def getInvitationByEmail(email: String): List[SpaceInvite]

    Find invitations of a space.

    Find invitations of a space. Get data from SpaceInviteDao.

  26. abstract def getInvitationBySpace(space: UUID): List[SpaceInvite]

    Find invitations of a space.

    Find invitations of a space. Get data from SpaceInviteDao.

  27. 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

  28. 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.

  29. abstract def getUsersInSpace(spaceId: UUID, role: Option[String]): 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

    role

    The role of the user in the space (optional filter)

    returns

    A list that contains all of the users that are associated with a specific space

  30. abstract def incrementCollectionCounter(collection: UUID, space: UUID, increment: Int): Unit

  31. abstract def incrementFileCounter(space: UUID, increment: Long): Unit

  32. abstract def incrementSpaceBytes(space: UUID, increment: Long): Unit

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

    insert new space, will return id if successful.

  34. 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.

  35. abstract def list(): List[ProjectSpace]

    list all spaces

  36. abstract def listAccess(date: String, nextPage: Boolean, limit: Integer, title: String, permisions: Set[Permission], user: Option[User], showAll: Boolean, showPublic: Boolean, showOnlyShared: Boolean): List[ProjectSpace]

    Return a list of spaces the user has access to starting at a specific date and matching title.

  37. abstract def listAccess(date: String, nextPage: Boolean, limit: Integer, permisions: Set[Permission], user: Option[User], showAll: Boolean, showPublic: Boolean, onlyTrial: Boolean, showOnlyShared: Boolean): List[ProjectSpace]

    Return a list of spaces the user has access to starting at a specific date.

  38. abstract def listAccess(limit: Integer, title: String, permisions: Set[Permission], user: Option[User], showAll: Boolean, showPublic: Boolean, showOnlyShared: Boolean): List[ProjectSpace]

    Return a list of spaces the user has access to matching title.

  39. abstract def listAccess(limit: Integer, permisions: Set[Permission], user: Option[User], showAll: Boolean, showPublic: Boolean, onlyTrial: Boolean, showOnlyShared: Boolean): List[ProjectSpace]

    Return a list of spaces the user has access to.

  40. abstract def listByStatus(status: String): List[ProjectSpace]

    Return a list of spaces with specific status

  41. abstract def listUser(date: String, nextPage: Boolean, limit: Integer, title: String, user: Option[User], showAll: Boolean, owner: User): List[ProjectSpace]

    Return a list of spaces the user has created starting at a specific date with matching title.

  42. abstract def listUser(date: String, nextPage: Boolean, limit: Integer, user: Option[User], showAll: Boolean, owner: User): List[ProjectSpace]

    Return a list of spaces the user has created starting at a specific date.

  43. abstract def listUser(limit: Integer, title: String, user: Option[User], showAll: Boolean, owner: User): List[ProjectSpace]

    Return a list of spaces the user has created with matching title.

  44. abstract def listUser(limit: Integer, user: Option[User], showAll: Boolean, owner: User): List[ProjectSpace]

    Return a list of spaces the user has created.

  45. abstract def processInvitation(email: String): Unit

    Find invitation for email and process it

  46. abstract def purgeExpiredResources(space: UUID, host: String, apiKey: Option[String], user: Option[User]): 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

  47. abstract def removeCollection(collection: UUID, space: UUID): Unit

  48. abstract def removeCurationObject(spaceId: UUID, curationObjectId: UUID): Unit

  49. abstract def removeDataset(dataset: UUID, space: UUID): Unit

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

    Remove follower from a file.

  51. abstract def removeInvitationFromSpace(inviteId: UUID, spaceId: UUID): Unit

    Remove Invitation to a space

  52. abstract def removeRequest(id: UUID, userId: UUID): Unit

    Remove authorization request.

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

    Remove a user from the space.

    Remove a user from the space.

    userId

    The identifier of the user to be removed from the space

    space

    The identifier for the space that the user is being removed from

  54. abstract def setDefaultExtractor(spaceId: UUID, extractor: String): Unit

    Follow the global setting for whether to trigger an extractor or not.

    Follow the global setting for whether to trigger an extractor or not.

    spaceId
    extractor

  55. abstract def update(model: ProjectSpace): Unit

    update space

  56. abstract def updateSpaceConfiguration(spaceId: UUID, name: String, description: String, timeToLive: Long, expireEnabled: Boolean, access: String): 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

    timeToLive

    The updated amount of time, in milliseconds, that resources should be preserved in the space

    expireEnabled

    The updated flag, indicating whether or not the space should allow resources to expire*

    access

    The updated flag indicate the space is private or public

  57. abstract def updateUserCount(space: UUID, numberOfUser: Int): Unit

    Update space.

    Update space.userCount if it is not correct.

    space

    The identifier of the space to be updated

    numberOfUser

    The number of user in space

Concrete Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any

  3. final def ##(): Int

    Definition Classes
    AnyRef → Any

  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any

  6. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  7. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  8. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  9. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  10. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  11. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any

  12. def hashCode(): Int

    Definition Classes
    AnyRef → Any

  13. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  14. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  15. final def notify(): Unit

    Definition Classes
    AnyRef

  16. final def notifyAll(): Unit

    Definition Classes
    AnyRef

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

    Definition Classes
    AnyRef

  18. def toString(): String

    Definition Classes
    AnyRef → Any

  19. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  21. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped