Click or drag to resize

CorrigoService Class

CorrigoService
Inheritance Hierarchy

Namespace: CorrigoService
Assembly: ClientXMLDoc (in ClientXMLDoc.exe) Version: 1.0.0.0 (1.0.0.0)
Syntax
public class CorrigoService : SoapHttpClientProtocol

The CorrigoService type exposes the following members.

Properties
 NameDescription
Public propertyCorrigoNetOptionsValue Holds the Corrigo Enterprise options SOAP header.
Public propertyUrl 
Public propertyUseDefaultCredentials 
Top
Methods
 NameDescription
Public methodCancelAsync Cancel userState Method.
Public methodExecute Executes a message that either represents a specialized method or specific business logic. It takes an instance of a CommandRequest base class message as input parameter and returns an instance of a CommandResponse base class message. You must cast the return value of the Execute method to the specific instance of the response command that corresponds to the request parameter.
Public methodExecuteAsync(CommandRequest) 
Public methodExecuteAsync(CommandRequest, Object) 
Public methodExecuteMultiple Executes a list of messages that either represents a specialized method or specific business logic. It takes a list of instances of a CommandRequest base class message as an input parameter and returns a list of instances of a CommandResponse base class message. You must cast every CommandResponse instance returned by the ExecuteMultiple method to the specific instance of the response command that corresponds to the appropriate request parameter.
Public methodExecuteMultipleAsync(CommandRequest) 
Public methodExecuteMultipleAsync(CommandRequest, Object) 
Public methodGetCompanyWsdkUrl Converts a Company Name argument into a fully-qualified URL for WSDK calls.
Public methodGetCompanyWsdkUrlAsync(String, Protocols) 
Public methodGetCompanyWsdkUrlAsync(String, Protocols, Object) 
Public methodLogInCompany Login into HOST-INDEPENDENT WSDL with Company Name, i.e. http://www.corrigonet.corrigo.com/...
Public methodLogInCompanyAsync(String, String, String) 
Public methodLogInCompanyAsync(String, String, String, Object) 
Public methodLogInStatus Get current Login status for the session.
Public methodLogInStatusAsync 
Public methodLogInStatusAsync(Object) 
Public methodLogOut Log Out of the session.
Public methodLogOutAsync 
Public methodLogOutAsync(Object) 
Public methodRetrieve Retrieves an instance of an entity. Takes two parameters: first of them specifies an entity by identifier and entity type (instance of EntitySpecifier class should be passed); second parameter specifies the set of properties to retrieve (to retrieve all properties, pass a new instance of the AllProperties class). Returns an instance of the CorrigoEntity requested or null if no entity was found. The CorrigoEntity class contains only the properties specified by the input parameter. Use this method to retrieve an instance of the CorrigoNet entity. Your client application must be logged in with sufficient access rights to retrieve a specified object and to retrieve the properties in the specified property list.
Public methodRetrieveAsync(EntitySpecifier, PropertySetBase) 
Public methodRetrieveAsync(EntitySpecifier, PropertySetBase, Object) 
Public methodRetrieveMultiple Uses a query expression to retrieve CorrigoNet entities. Takes single parameter which specifies either a QueryExpression or a QueryByProperty object derived from the QueryBase class. This is the query to be executed for an entity. Returns a collection of entities of the type specified in the query parameter. If the query specified returned no results, an empty collection is returned. Use this method to retrieve one or more entity instances based on criteria specified in the input parameter.
Public methodRetrieveMultipleAsync(QueryBase) 
Public methodRetrieveMultipleAsync(QueryBase, Object) 
Top
Events
See Also