uk.ac.soton.itinnovation.grid.comms.account
Interface AccountResource

All Superinterfaces:

PolicyManagement, ResourceMetadata, Signallable

All Known Subinterfaces:

AccountConversation, PrivateAccountConversation, PrivateAccountResource, PrivateAccountServiceSOAP, TradeAccountConversation, TradeAccountResource, TradeAccountServiceSOAP

All Known Implementing Classes:

AccountConversationImpl, PrivateAccountConversationImpl, PrivateAccountServiceImpl, TradeAccountConversationImpl, TradeAccountServiceImpl

public interface AccountResource
extends PolicyManagement, ResourceMetadata, Signallable

Method Summary

void	addBudgetHolderRule(MatchRule rule) Deprecated.
void	addUserRule(MatchRule delegate) Deprecated.
boolean	checkUser(SubjectDescription user) Test whether this user has the 'user' role.
void	closeAccount() Close an account
AccountStatement	getAccountStatement(Date periodStart, Date periodEnd) Get a statement for an account
String	getAccountStatus() Get the current status of an account
MatchRule[]	getBudgetHolderRules() Deprecated.
MatchRule[]	getUserRules() Deprecated.
void	removeBudgetHolderRule(MatchRule rule) Deprecated.
void	removeUserRule(MatchRule delegate) Deprecated.

Methods inherited from interface uk.ac.soton.itinnovation.grid.types.PolicyManagement

addPolicyRule, getPolicyRules, getValidRoles, removePolicyRule

Methods inherited from interface uk.ac.soton.itinnovation.grid.types.ResourceMetadata

getEPR, setLabel

Methods inherited from interface uk.ac.soton.itinnovation.grid.types.Signallable

getAvailableSignals, signal

Method Detail

getAccountStatus

@WebMethod
String getAccountStatus()
                        throws RemoteException

Get the current status of an account

Returns:

the account's status

Throws:

RemoteException - If the account status cannot be accessed

getAccountStatement

@WebMethod
AccountStatement getAccountStatement(Date periodStart,
                                               Date periodEnd)
                                     throws RemoteException

Get a statement for an account

Parameters:

periodStart - - the start of the period the statement should cover

periodEnd - - the start of the period the statement should cover

Returns:

A generated statement for the account

Throws:

RemoteException - If the account statement cannot be generated

addUserRule

@WebMethod
@Deprecated
void addUserRule(MatchRule delegate)
                 throws RemoteException

Deprecated.

Enable access to an account to another user

Parameters:

delegate - - the delegate

Throws:

RemoteException - If there is a problem enabling access to the account for the user

removeUserRule

@WebMethod
@Deprecated
void removeUserRule(MatchRule delegate)
                    throws RemoteException

Deprecated.

Disable access to an account for a user

Parameters:

delegate - - the delegate

Throws:

RemoteException - If there is a problem disabling access to the account for the use

getUserRules

@WebMethod
@Deprecated
MatchRule[] getUserRules()
                         throws RemoteException

Deprecated.

List the current rules used to determine whether someone has the 'user' role (which allows them to charge to this account.

Throws:

RemoteException

addBudgetHolderRule

@WebMethod
@Deprecated
void addBudgetHolderRule(MatchRule rule)
                         throws RemoteException

Deprecated.

Add a rule controlling access to the budget-holder role.

Parameters:

rule - - the rule to add (role must be "budget-holder")

Throws:

RemoteException

removeBudgetHolderRule

@WebMethod
@Deprecated
void removeBudgetHolderRule(MatchRule rule)
                            throws RemoteException

Deprecated.

Remove a rule controlling access to the budget-holder role.

Parameters:

rule - - the rule to remove (role must be "budget-holder")

Throws:

RemoteException

getBudgetHolderRules

@WebMethod
@Deprecated
MatchRule[] getBudgetHolderRules()
                                 throws RemoteException

Deprecated.

List the current rules used to determine whether someone has the 'budget-holder' role.

Throws:

RemoteException

closeAccount

@WebMethod
void closeAccount()
                  throws RemoteException

Close an account

Throws:

RemoteException - If the account cannot be closed

checkUser

@WebMethod
boolean checkUser(SubjectDescription user)
                  throws RemoteException

Test whether this user has the 'user' role.

Parameters:

user - user to test.

Returns:

true if this is a valid user of the account, or false if not

Throws:

RemoteException - if the caller is not permitted to check