org.icatproject

Interface ICAT

public interface ICAT

This class was generated by the JAX-WS RI. JAX-WS RI 2.2.8 Generated source version: 2.2

Method Summary

Modifier and Type	Method and Description
long	create(String sessionId, EntityBaseBean bean)
List<Long>	createMany(String sessionId, List<EntityBaseBean> beans)
void	delete(String sessionId, EntityBaseBean bean)
void	deleteMany(String sessionId, List<EntityBaseBean> beans)
void	dummy(Datafile arg0, DatafileFormat arg1, DatafileParameter arg2, Dataset arg3, DatasetParameter arg4, DatasetType arg5, Facility arg6, FacilityCycle arg7, InstrumentScientist arg8, User arg9, Instrument arg10, Investigation arg11, InvestigationType arg12, InvestigationUser arg13, Keyword arg14, ParameterType arg15, Publication arg16, RelatedDatafile arg17, Sample arg18, SampleParameter arg19, Shift arg20, Study arg21, StudyInvestigation arg22, StudyStatus arg23, Application arg24, Job arg25, DataCollection arg26, DataCollectionParameter arg27, DataCollectionDataset arg28, DataCollectionDatafile arg29, Grouping arg30, UserGroup arg31, PublicStep arg32, FieldSet arg33)
EntityBaseBean	get(String sessionId, String query, long primaryKey)
String	getApiVersion()
List<AuthenticatorInfo>	getAuthenticatorInfo()
EntityInfo	getEntityInfo(String beanName)
List<String>	getEntityNames()
List<String>	getProperties(String sessionId)
double	getRemainingMinutes(String sessionId)
String	getUserName(String sessionId)
String	getVersion()
boolean	isAccessAllowed(String sessionId, EntityBaseBean bean, AccessType accessType)
String	login(String plugin, Login.Credentials credentials)
void	logout(String sessionId)
void	refresh(String sessionId)
List<Object>	search(String sessionId, String query)
void	update(String sessionId, EntityBaseBean bean)

Method Detail

logout

@RequestWrapper(localName="logout",
                targetNamespace="http://icatproject.org",
                className="org.icatproject.Logout")
 @ResponseWrapper(localName="logoutResponse",
                 targetNamespace="http://icatproject.org",
                 className="org.icatproject.LogoutResponse")
 @Action(input="http://icatproject.org/ICAT/logoutRequest",
        output="http://icatproject.org/ICAT/logoutResponse",
        fault=@FaultAction(className=IcatException_Exception.class,value="http://icatproject.org/ICAT/logout/Fault/IcatException"))
void logout(String sessionId)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          throws IcatException_Exception

Parameters:

sessionId -

Throws:

IcatException_Exception

login

@RequestWrapper(localName="login",
                targetNamespace="http://icatproject.org",
                className="org.icatproject.Login")
 @ResponseWrapper(localName="loginResponse",
                 targetNamespace="http://icatproject.org",
                 className="org.icatproject.LoginResponse")
 @Action(input="http://icatproject.org/ICAT/loginRequest",
        output="http://icatproject.org/ICAT/loginResponse",
        fault=@FaultAction(className=IcatException_Exception.class,value="http://icatproject.org/ICAT/login/Fault/IcatException"))
String login(String plugin,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           Login.Credentials credentials)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    throws IcatException_Exception

Parameters:

plugin -

credentials -

Returns:

returns java.lang.String

Throws:

IcatException_Exception

getRemainingMinutes

@RequestWrapper(localName="getRemainingMinutes",
                targetNamespace="http://icatproject.org",
                className="org.icatproject.GetRemainingMinutes")
 @ResponseWrapper(localName="getRemainingMinutesResponse",
                 targetNamespace="http://icatproject.org",
                 className="org.icatproject.GetRemainingMinutesResponse")
 @Action(input="http://icatproject.org/ICAT/getRemainingMinutesRequest",
        output="http://icatproject.org/ICAT/getRemainingMinutesResponse",
        fault=@FaultAction(className=IcatException_Exception.class,value="http://icatproject.org/ICAT/getRemainingMinutes/Fault/IcatException"))
double getRemainingMinutes(String sessionId)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    throws IcatException_Exception

Parameters:

sessionId -

Returns:

returns double

Throws:

IcatException_Exception

getAuthenticatorInfo

@RequestWrapper(localName="getAuthenticatorInfo",
                targetNamespace="http://icatproject.org",
                className="org.icatproject.GetAuthenticatorInfo")
 @ResponseWrapper(localName="getAuthenticatorInfoResponse",
                 targetNamespace="http://icatproject.org",
                 className="org.icatproject.GetAuthenticatorInfoResponse")
 @Action(input="http://icatproject.org/ICAT/getAuthenticatorInfoRequest",
        output="http://icatproject.org/ICAT/getAuthenticatorInfoResponse",
        fault=@FaultAction(className=IcatException_Exception.class,value="http://icatproject.org/ICAT/getAuthenticatorInfo/Fault/IcatException"))
List<AuthenticatorInfo> getAuthenticatorInfo()
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             throws IcatException_Exception

Returns:

returns java.util.List

Throws:

IcatException_Exception

getEntityNames

@RequestWrapper(localName="getEntityNames",
                targetNamespace="http://icatproject.org",
                className="org.icatproject.GetEntityNames")
 @ResponseWrapper(localName="getEntityNamesResponse",
                 targetNamespace="http://icatproject.org",
                 className="org.icatproject.GetEntityNamesResponse")
 @Action(input="http://icatproject.org/ICAT/getEntityNamesRequest",
        output="http://icatproject.org/ICAT/getEntityNamesResponse",
        fault=@FaultAction(className=IcatException_Exception.class,value="http://icatproject.org/ICAT/getEntityNames/Fault/IcatException"))
List<String> getEntityNames()
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  throws IcatException_Exception

Returns:

returns java.util.List

Throws:

IcatException_Exception

createMany

@RequestWrapper(localName="createMany",
                targetNamespace="http://icatproject.org",
                className="org.icatproject.CreateMany")
 @ResponseWrapper(localName="createManyResponse",
                 targetNamespace="http://icatproject.org",
                 className="org.icatproject.CreateManyResponse")
 @Action(input="http://icatproject.org/ICAT/createManyRequest",
        output="http://icatproject.org/ICAT/createManyResponse",
        fault=@FaultAction(className=IcatException_Exception.class,value="http://icatproject.org/ICAT/createMany/Fault/IcatException"))
List<Long> createMany(String sessionId,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       List<EntityBaseBean> beans)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                throws IcatException_Exception

Parameters:

beans -

sessionId -

Returns:

returns java.util.List

Throws:

IcatException_Exception

getEntityInfo

@RequestWrapper(localName="getEntityInfo",
                targetNamespace="http://icatproject.org",
                className="org.icatproject.GetEntityInfo")
 @ResponseWrapper(localName="getEntityInfoResponse",
                 targetNamespace="http://icatproject.org",
                 className="org.icatproject.GetEntityInfoResponse")
 @Action(input="http://icatproject.org/ICAT/getEntityInfoRequest",
        output="http://icatproject.org/ICAT/getEntityInfoResponse",
        fault=@FaultAction(className=IcatException_Exception.class,value="http://icatproject.org/ICAT/getEntityInfo/Fault/IcatException"))
EntityInfo getEntityInfo(String beanName)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        throws IcatException_Exception

Parameters:

beanName -

Returns:

returns org.icatproject.EntityInfo

Throws:

IcatException_Exception

isAccessAllowed

@RequestWrapper(localName="isAccessAllowed",
                targetNamespace="http://icatproject.org",
                className="org.icatproject.IsAccessAllowed")
 @ResponseWrapper(localName="isAccessAllowedResponse",
                 targetNamespace="http://icatproject.org",
                 className="org.icatproject.IsAccessAllowedResponse")
 @Action(input="http://icatproject.org/ICAT/isAccessAllowedRequest",
        output="http://icatproject.org/ICAT/isAccessAllowedResponse",
        fault=@FaultAction(className=IcatException_Exception.class,value="http://icatproject.org/ICAT/isAccessAllowed/Fault/IcatException"))
boolean isAccessAllowed(String sessionId,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            EntityBaseBean bean,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            AccessType accessType)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     throws IcatException_Exception

Parameters:

accessType -

sessionId -

bean -

Returns:

returns boolean

Throws:

IcatException_Exception

deleteMany

@RequestWrapper(localName="deleteMany",
                targetNamespace="http://icatproject.org",
                className="org.icatproject.DeleteMany")
 @ResponseWrapper(localName="deleteManyResponse",
                 targetNamespace="http://icatproject.org",
                 className="org.icatproject.DeleteManyResponse")
 @Action(input="http://icatproject.org/ICAT/deleteManyRequest",
        output="http://icatproject.org/ICAT/deleteManyResponse",
        fault=@FaultAction(className=IcatException_Exception.class,value="http://icatproject.org/ICAT/deleteMany/Fault/IcatException"))
void deleteMany(String sessionId,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 List<EntityBaseBean> beans)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          throws IcatException_Exception

Parameters:

beans -

sessionId -

Throws:

IcatException_Exception

getVersion

@RequestWrapper(localName="getVersion",
                targetNamespace="http://icatproject.org",
                className="org.icatproject.GetVersion")
 @ResponseWrapper(localName="getVersionResponse",
                 targetNamespace="http://icatproject.org",
                 className="org.icatproject.GetVersionResponse")
 @Action(input="http://icatproject.org/ICAT/getVersionRequest",
        output="http://icatproject.org/ICAT/getVersionResponse",
        fault=@FaultAction(className=IcatException_Exception.class,value="http://icatproject.org/ICAT/getVersion/Fault/IcatException"))
String getVersion()
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            throws IcatException_Exception

Returns:

returns java.lang.String

Throws:

IcatException_Exception

dummy

@RequestWrapper(localName="dummy",
                targetNamespace="http://icatproject.org",
                className="org.icatproject.Dummy")
 @ResponseWrapper(localName="dummyResponse",
                 targetNamespace="http://icatproject.org",
                 className="org.icatproject.DummyResponse")
 @Action(input="http://icatproject.org/ICAT/dummyRequest",
        output="http://icatproject.org/ICAT/dummyResponse")
void dummy(Datafile arg0,
                                                                                                                                                                                                                                                                                                                                                                                                                                                      DatafileFormat arg1,
                                                                                                                                                                                                                                                                                                                                                                                                                                                      DatafileParameter arg2,
                                                                                                                                                                                                                                                                                                                                                                                                                                                      Dataset arg3,
                                                                                                                                                                                                                                                                                                                                                                                                                                                      DatasetParameter arg4,
                                                                                                                                                                                                                                                                                                                                                                                                                                                      DatasetType arg5,
                                                                                                                                                                                                                                                                                                                                                                                                                                                      Facility arg6,
                                                                                                                                                                                                                                                                                                                                                                                                                                                      FacilityCycle arg7,
                                                                                                                                                                                                                                                                                                                                                                                                                                                      InstrumentScientist arg8,
                                                                                                                                                                                                                                                                                                                                                                                                                                                      User arg9,
                                                                                                                                                                                                                                                                                                                                                                                                                                                      Instrument arg10,
                                                                                                                                                                                                                                                                                                                                                                                                                                                      Investigation arg11,
                                                                                                                                                                                                                                                                                                                                                                                                                                                      InvestigationType arg12,
                                                                                                                                                                                                                                                                                                                                                                                                                                                      InvestigationUser arg13,
                                                                                                                                                                                                                                                                                                                                                                                                                                                      Keyword arg14,
                                                                                                                                                                                                                                                                                                                                                                                                                                                      ParameterType arg15,
                                                                                                                                                                                                                                                                                                                                                                                                                                                      Publication arg16,
                                                                                                                                                                                                                                                                                                                                                                                                                                                      RelatedDatafile arg17,
                                                                                                                                                                                                                                                                                                                                                                                                                                                      Sample arg18,
                                                                                                                                                                                                                                                                                                                                                                                                                                                      SampleParameter arg19,
                                                                                                                                                                                                                                                                                                                                                                                                                                                      Shift arg20,
                                                                                                                                                                                                                                                                                                                                                                                                                                                      Study arg21,
                                                                                                                                                                                                                                                                                                                                                                                                                                                      StudyInvestigation arg22,
                                                                                                                                                                                                                                                                                                                                                                                                                                                      StudyStatus arg23,
                                                                                                                                                                                                                                                                                                                                                                                                                                                      Application arg24,
                                                                                                                                                                                                                                                                                                                                                                                                                                                      Job arg25,
                                                                                                                                                                                                                                                                                                                                                                                                                                                      DataCollection arg26,
                                                                                                                                                                                                                                                                                                                                                                                                                                                      DataCollectionParameter arg27,
                                                                                                                                                                                                                                                                                                                                                                                                                                                      DataCollectionDataset arg28,
                                                                                                                                                                                                                                                                                                                                                                                                                                                      DataCollectionDatafile arg29,
                                                                                                                                                                                                                                                                                                                                                                                                                                                      Grouping arg30,
                                                                                                                                                                                                                                                                                                                                                                                                                                                      UserGroup arg31,
                                                                                                                                                                                                                                                                                                                                                                                                                                                      PublicStep arg32,
                                                                                                                                                                                                                                                                                                                                                                                                                                                      FieldSet arg33)

Parameters:

arg7 -

arg6 -

arg9 -

arg8 -

arg28 -

arg29 -

arg24 -

arg25 -

arg26 -

arg27 -

arg20 -

arg21 -

arg22 -

arg23 -

arg3 -

arg17 -

arg2 -

arg18 -

arg5 -

arg19 -

arg4 -

arg13 -

arg14 -

arg1 -

arg15 -

arg0 -

arg16 -

arg31 -

arg10 -

arg32 -

arg11 -

arg33 -

arg12 -

arg30 -

refresh

@RequestWrapper(localName="refresh",
                targetNamespace="http://icatproject.org",
                className="org.icatproject.Refresh")
 @ResponseWrapper(localName="refreshResponse",
                 targetNamespace="http://icatproject.org",
                 className="org.icatproject.RefreshResponse")
 @Action(input="http://icatproject.org/ICAT/refreshRequest",
        output="http://icatproject.org/ICAT/refreshResponse",
        fault=@FaultAction(className=IcatException_Exception.class,value="http://icatproject.org/ICAT/refresh/Fault/IcatException"))
void refresh(String sessionId)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  throws IcatException_Exception

Parameters:

sessionId -

Throws:

IcatException_Exception

getApiVersion

@RequestWrapper(localName="getApiVersion",
                targetNamespace="http://icatproject.org",
                className="org.icatproject.GetApiVersion")
 @ResponseWrapper(localName="getApiVersionResponse",
                 targetNamespace="http://icatproject.org",
                 className="org.icatproject.GetApiVersionResponse")
 @Action(input="http://icatproject.org/ICAT/getApiVersionRequest",
        output="http://icatproject.org/ICAT/getApiVersionResponse",
        fault=@FaultAction(className=IcatException_Exception.class,value="http://icatproject.org/ICAT/getApiVersion/Fault/IcatException"))
String getApiVersion()
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    throws IcatException_Exception

Returns:

returns java.lang.String

Throws:

IcatException_Exception

getUserName

@RequestWrapper(localName="getUserName",
                targetNamespace="http://icatproject.org",
                className="org.icatproject.GetUserName")
 @ResponseWrapper(localName="getUserNameResponse",
                 targetNamespace="http://icatproject.org",
                 className="org.icatproject.GetUserNameResponse")
 @Action(input="http://icatproject.org/ICAT/getUserNameRequest",
        output="http://icatproject.org/ICAT/getUserNameResponse",
        fault=@FaultAction(className=IcatException_Exception.class,value="http://icatproject.org/ICAT/getUserName/Fault/IcatException"))
String getUserName(String sessionId)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    throws IcatException_Exception

Parameters:

sessionId -

Returns:

returns java.lang.String

Throws:

IcatException_Exception

get

@RequestWrapper(localName="get",
                targetNamespace="http://icatproject.org",
                className="org.icatproject.Get")
 @ResponseWrapper(localName="getResponse",
                 targetNamespace="http://icatproject.org",
                 className="org.icatproject.GetResponse")
 @Action(input="http://icatproject.org/ICAT/getRequest",
        output="http://icatproject.org/ICAT/getResponse",
        fault=@FaultAction(className=IcatException_Exception.class,value="http://icatproject.org/ICAT/get/Fault/IcatException"))
EntityBaseBean get(String sessionId,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   String query,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   long primaryKey)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            throws IcatException_Exception

Parameters:

query -

sessionId -

primaryKey -

Returns:

returns org.icatproject.EntityBaseBean

Throws:

IcatException_Exception

update

@RequestWrapper(localName="update",
                targetNamespace="http://icatproject.org",
                className="org.icatproject.Update")
 @ResponseWrapper(localName="updateResponse",
                 targetNamespace="http://icatproject.org",
                 className="org.icatproject.UpdateResponse")
 @Action(input="http://icatproject.org/ICAT/updateRequest",
        output="http://icatproject.org/ICAT/updateResponse",
        fault=@FaultAction(className=IcatException_Exception.class,value="http://icatproject.org/ICAT/update/Fault/IcatException"))
void update(String sessionId,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 EntityBaseBean bean)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          throws IcatException_Exception

Parameters:

sessionId -

bean -

Throws:

IcatException_Exception

getProperties

@RequestWrapper(localName="getProperties",
                targetNamespace="http://icatproject.org",
                className="org.icatproject.GetProperties")
 @ResponseWrapper(localName="getPropertiesResponse",
                 targetNamespace="http://icatproject.org",
                 className="org.icatproject.GetPropertiesResponse")
 @Action(input="http://icatproject.org/ICAT/getPropertiesRequest",
        output="http://icatproject.org/ICAT/getPropertiesResponse",
        fault=@FaultAction(className=IcatException_Exception.class,value="http://icatproject.org/ICAT/getProperties/Fault/IcatException"))
List<String> getProperties(String sessionId)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          throws IcatException_Exception

Parameters:

sessionId -

Returns:

returns java.util.List

Throws:

IcatException_Exception

delete

@RequestWrapper(localName="delete",
                targetNamespace="http://icatproject.org",
                className="org.icatproject.Delete")
 @ResponseWrapper(localName="deleteResponse",
                 targetNamespace="http://icatproject.org",
                 className="org.icatproject.DeleteResponse")
 @Action(input="http://icatproject.org/ICAT/deleteRequest",
        output="http://icatproject.org/ICAT/deleteResponse",
        fault=@FaultAction(className=IcatException_Exception.class,value="http://icatproject.org/ICAT/delete/Fault/IcatException"))
void delete(String sessionId,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 EntityBaseBean bean)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          throws IcatException_Exception

Parameters:

sessionId -

bean -

Throws:

IcatException_Exception

create

@RequestWrapper(localName="create",
                targetNamespace="http://icatproject.org",
                className="org.icatproject.Create")
 @ResponseWrapper(localName="createResponse",
                 targetNamespace="http://icatproject.org",
                 className="org.icatproject.CreateResponse")
 @Action(input="http://icatproject.org/ICAT/createRequest",
        output="http://icatproject.org/ICAT/createResponse",
        fault=@FaultAction(className=IcatException_Exception.class,value="http://icatproject.org/ICAT/create/Fault/IcatException"))
long create(String sessionId,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 EntityBaseBean bean)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          throws IcatException_Exception

Parameters:

sessionId -

bean -

Returns:

returns long

Throws:

IcatException_Exception

search

@RequestWrapper(localName="search",
                targetNamespace="http://icatproject.org",
                className="org.icatproject.Search")
 @ResponseWrapper(localName="searchResponse",
                 targetNamespace="http://icatproject.org",
                 className="org.icatproject.SearchResponse")
 @Action(input="http://icatproject.org/ICAT/searchRequest",
        output="http://icatproject.org/ICAT/searchResponse",
        fault=@FaultAction(className=IcatException_Exception.class,value="http://icatproject.org/ICAT/search/Fault/IcatException"))
List<Object> search(String sessionId,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         String query)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  throws IcatException_Exception

Parameters:

query -

sessionId -

Returns:

returns java.util.List

Throws:

IcatException_Exception