public class MonitoringAppSoapStub extends com.collabnet.ce.soap60.webservices.ClientSoapStub implements IMonitoringAppSoap
Constructor and Description |
---|
MonitoringAppSoapStub(String soapServerUrl) |
Modifier and Type | Method and Description |
---|---|
com.collabnet.ce.soap60.types.SoapNamedValues |
getApplicationMonitoringNotificationPreferences(String sessionId,
String projectId)
Gets current user's application level monitoring notification preferences for the spcified project
|
int |
getMonitoringNotificationPreference(String sessionId)
Gets monitoring notification preference for current user
|
MonitoringSubscriptionSoapDO |
getMonitoringSubscription(String sessionId,
String objectId)
Gets the current user's subscription data on the specified object.
|
MonitoringSubscriptionSoapList |
getMonitoringSubscriptions(String sessionId,
com.collabnet.ce.soap60.types.SoapFilter[] filters)
Gets the list of current user's subscriptions optionally filtered by the specified filters
|
boolean |
isMonitoring(String sessionId,
String objectId)
Gets whether the specified object is being monitored by current user or not.
|
boolean |
isUserMonitoring(String sessionId,
String userName,
String objectId)
Gets whether the specified object is being monitored by the given user name or not.
|
MonitoringUserSoapList |
listMonitoringUsers(String sessionId,
String objectId)
Gets the list of users monitoring the specified object.
|
void |
setApplicationMonitoringNotificationPreferences(String sessionId,
String projectId,
com.collabnet.ce.soap60.types.SoapNamedValues appPreferences)
Sets current user's application level monitoring notification preferences for the specified project
|
void |
setMonitoringNotificationPreference(String sessionId,
int preference)
Sets monitoring notification preference for current user.
|
void |
startMonitoring(String sessionId,
String objectId)
Starts monitoring the specified object for current user
|
void |
startMonitoringByUser(String sessionId,
String userName,
String objectId)
Starts monitoring the specified object for the given user
|
void |
stopMonitoring(String sessionId,
String objectId)
Stops monitoring the specified object for current user.
|
void |
stopMonitoringByUser(String sessionId,
String userName,
String objectId)
Stops monitoring the specified object for the given user.
|
public MonitoringAppSoapStub(String soapServerUrl)
public boolean isMonitoring(String sessionId, String objectId) throws RemoteException
IMonitoringAppSoap
isMonitoring
in interface IMonitoringAppSoap
sessionId
- User session idobjectId
- the object id for which we are doing the checkcom.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- when the specified object id is invalid.com.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system level error occurs.RemoteException
public boolean isUserMonitoring(String sessionId, String userName, String objectId) throws RemoteException
IMonitoringAppSoap
isUserMonitoring
in interface IMonitoringAppSoap
sessionId
- User session idobjectId
- the object id for which we are doing the checkcom.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- when the specified object id is invalid.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- when userName isn't the current user, and current user can't view the object.com.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system level error occurs.com.collabnet.ce.soap60.fault.IllegalArgumentFault
- when the specified userName is invalid.RemoteException
public void stopMonitoring(String sessionId, String objectId) throws RemoteException
IMonitoringAppSoap
stopMonitoring
in interface IMonitoringAppSoap
sessionId
- User session idobjectId
- the object id which current user will stop monitoringcom.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- when the specified object id is invalid.com.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system level error occurs.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- when current user does not enough permission on the given object.RemoteException
public void stopMonitoringByUser(String sessionId, String userName, String objectId) throws RemoteException
IMonitoringAppSoap
stopMonitoringByUser
in interface IMonitoringAppSoap
sessionId
- User session iduserName
- user name of the user who needs to stop monitoringobjectId
- the object id which the given user will stop monitoringcom.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- when the specified object id is invalid.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- when userName isn't the current user, and current user doesn't have admin perm. on the object.com.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system level error occurs.com.collabnet.ce.soap60.fault.IllegalArgumentFault
- when the specified user name is invalid.RemoteException
public void startMonitoring(String sessionId, String objectId) throws RemoteException
IMonitoringAppSoap
startMonitoring
in interface IMonitoringAppSoap
sessionId
- User session idobjectId
- the object id which current user will start monitoringcom.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- when the specified object id is invalid.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- when current user can't view the object,com.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system level error occurs.RemoteException
public void startMonitoringByUser(String sessionId, String userName, String objectId) throws RemoteException
IMonitoringAppSoap
startMonitoringByUser
in interface IMonitoringAppSoap
sessionId
- User session iduserName
- user name of the user who needs to monitorobjectId
- the object id which the given user will start monitoringcom.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- when the specified object id is invalid.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- when userName does not have view permission on the object, when userName isn't the current user, and current user doesn't have admin perm. on the object.com.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system level error occurs.com.collabnet.ce.soap60.fault.IllegalArgumentFault
- when the given user name is not valid.RemoteException
public MonitoringUserSoapList listMonitoringUsers(String sessionId, String objectId) throws RemoteException
IMonitoringAppSoap
listMonitoringUsers
in interface IMonitoringAppSoap
sessionId
- User session idobjectId
- the object idcom.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- when the specified object id is invalid.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- when current user can't view the object.com.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system level error occurs.RemoteException
public MonitoringSubscriptionSoapList getMonitoringSubscriptions(String sessionId, com.collabnet.ce.soap60.types.SoapFilter[] filters) throws RemoteException
IMonitoringAppSoap
getMonitoringSubscriptions
in interface IMonitoringAppSoap
sessionId
- User session idfilters
- Array of filters to apply (null to return unfiltered list).com.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.InvalidFilterFault
- when an unsupported filter exists in the filter collection.com.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system level error occurs.RemoteException
public MonitoringSubscriptionSoapDO getMonitoringSubscription(String sessionId, String objectId) throws RemoteException
IMonitoringAppSoap
getMonitoringSubscription
in interface IMonitoringAppSoap
sessionId
- User session idobjectId
- Id of the objectcom.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- when the specified object id is invalid.com.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system level error occurs.RemoteException
public int getMonitoringNotificationPreference(String sessionId) throws RemoteException
IMonitoringAppSoap
getMonitoringNotificationPreference
in interface IMonitoringAppSoap
sessionId
- User session idcom.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system level error occurs.RemoteException
public void setMonitoringNotificationPreference(String sessionId, int preference) throws RemoteException
IMonitoringAppSoap
setMonitoringNotificationPreference
in interface IMonitoringAppSoap
sessionId
- User session idpreference
- Integer value representing the subscription type; 1:email, 2:digest, 3:nonecom.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system level error occurs.RemoteException
public void setApplicationMonitoringNotificationPreferences(String sessionId, String projectId, com.collabnet.ce.soap60.types.SoapNamedValues appPreferences) throws RemoteException
IMonitoringAppSoap
setApplicationMonitoringNotificationPreferences
in interface IMonitoringAppSoap
sessionId
- User session idprojectId
- Project idappPreferences
- Application preferences.com.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- when the specified project id is invalid, when an application name is invalid.com.collabnet.ce.soap60.fault.IllegalArgumentFault
- when the application preferences are invalid.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- when current user can view the object.com.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system level error occurs.RemoteException
public com.collabnet.ce.soap60.types.SoapNamedValues getApplicationMonitoringNotificationPreferences(String sessionId, String projectId) throws RemoteException
IMonitoringAppSoap
getApplicationMonitoringNotificationPreferences
in interface IMonitoringAppSoap
sessionId
- User session idprojectId
- Project idcom.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- when the specified project id is invalid.RemoteException
Copyright © 2016 CollabNet. All Rights Reserved.