fr.cnes.sitools.userstorage
Interface UserStorageStore

All Superinterfaces:
java.io.Closeable
All Known Implementing Classes:
UserStorageStoreXML

public interface UserStorageStore
extends java.io.Closeable

Interface for managing UserStorage objects persistence.

Author:
jp.boignard (AKKA Technologies)

Method Summary
 UserStorage create(UserStorage userStorage)
          Method for creating a UserStorage
 boolean delete(java.lang.String id)
          Method for deleting a UserStorage by its id
 UserStorage[] getArray()
          Method for getting all objects
 UserStorage[] getArray(ResourceCollectionFilter filter)
          Method for getting userStorages according to the specified filter
 UserStorage[] getArrayByXQuery(java.lang.String xquery)
          Method for getting objects according to the XQuery
 java.util.List<UserStorage> getList()
          Method for getting all userStorage
 java.util.List<UserStorage> getList(ResourceCollectionFilter filter)
          Method for getting userStorage with specific criteria
 java.util.List<UserStorage> getListByXQuery(java.lang.String xquery)
          Method for getting userStorage with XQuery request syntax
 java.util.List<UserStorage> getPage(ResourceCollectionFilter filter, java.util.List<UserStorage> userStorages)
          Method for getting userStorages according to the pagination criteria
 UserStorage retrieve(java.lang.String id)
          Method for retrieving a userStorage by its id
 UserStorage update(UserStorage userStorage)
          Method for updating a userStorage
 
Methods inherited from interface java.io.Closeable
close
 

Method Detail

getArray

UserStorage[] getArray()
Method for getting all objects

Returns:
Array

getArrayByXQuery

UserStorage[] getArrayByXQuery(java.lang.String xquery)
Method for getting objects according to the XQuery

Parameters:
xquery - String with XQuery syntax
Returns:
Array

getArray

UserStorage[] getArray(ResourceCollectionFilter filter)
Method for getting userStorages according to the specified filter

Parameters:
filter - criteria (pagination, ...)
Returns:
Array

getList

java.util.List<UserStorage> getList()
Method for getting all userStorage

Returns:
ArrayList of userStorage

getList

java.util.List<UserStorage> getList(ResourceCollectionFilter filter)
Method for getting userStorage with specific criteria

Parameters:
filter - criteria (pagination, ...)
Returns:
ArrayList of userStorage

getPage

java.util.List<UserStorage> getPage(ResourceCollectionFilter filter,
                                    java.util.List<UserStorage> userStorages)
Method for getting userStorages according to the pagination criteria

Parameters:
filter - pagination
userStorages - input
Returns:
ArrayList of userStorage

getListByXQuery

java.util.List<UserStorage> getListByXQuery(java.lang.String xquery)
Method for getting userStorage with XQuery request syntax

Parameters:
xquery - String
Returns:
ArrayList of userStorage

create

UserStorage create(UserStorage userStorage)
                   throws SitoolsException
Method for creating a UserStorage

Parameters:
userStorage - UserStorage input
Returns:
created UserStorage
Throws:
SitoolsException - if error occurs when creating a new UserStorage

retrieve

UserStorage retrieve(java.lang.String id)
Method for retrieving a userStorage by its id

Parameters:
id - userStorage identifier
Returns:
retrieved userStorage

update

UserStorage update(UserStorage userStorage)
Method for updating a userStorage

Parameters:
userStorage - input
Returns:
updated userStorage

delete

boolean delete(java.lang.String id)
Method for deleting a UserStorage by its id

Parameters:
id - userStorage identifier
Returns:
true if deleted


Copyright © 2010-2013 CNES. All Rights Reserved.