| java.lang.Object
 org.ofbiz.service.ModelService
| Method Summary | |
| public void | addParam(ModelParam param)
Adds a parameter definition to this service; puts on list in order added
then sorts by order if specified. | | public void | addParamClone(ModelParam param)
| | public boolean | containsPermissions()
| | public String | debugInfo()
| | public boolean | evalPermissions(Security security, GenericValue userLogin)
Evaluates permissions for a service. | | public Set | getAllParamNames()
| | public List | getInModelParamList()
Returns a list of ModelParam objects in the order they were defined when
the service was created. | | public Set | getInParamNames()
| | public List | getInParameterSequence(Map source)
Gets a list of required IN parameters in sequence. | | public List | getModelParamList()
Returns a list of ModelParam objects in the order they were defined when
the service was created. | | public Set | getOutParamNames()
| | public ModelParam | getParam(String name)
| | public List | getParameterNames(String mode, boolean optional)
Gets the parameter names of the specified mode (IN/OUT/INOUT). | | public boolean | inheritedParameters()
| | public synchronized void | interfaceUpdate(DispatchContext dctx)
| | public Map | makeValid(Map source, String mode)
Creates a new Map based from an existing map with just valid parameters. | | public Map | makeValid(Map source, String mode, boolean includeInternal)
Creates a new Map based from an existing map with just valid parameters. | | public String | toString()
| | public void | validate(Map test, String mode)
| | public static void | validate(Map info, Map test, boolean reverse, ModelService model, String mode)
|
| ERROR_MESSAGE_LIST | | final public static String ERROR_MESSAGE_LIST(Code) | | |
| ERROR_MESSAGE_MAP | | final public static String ERROR_MESSAGE_MAP(Code) | | |
| RESPOND_SUCCESS | | final public static String RESPOND_SUCCESS(Code) | | |
| RESPONSE_MESSAGE | | final public static String RESPONSE_MESSAGE(Code) | | |
| SUCCESS_MESSAGE | | final public static String SUCCESS_MESSAGE(Code) | | |
| SUCCESS_MESSAGE_LIST | | final public static String SUCCESS_MESSAGE_LIST(Code) | | |
| auth | | public boolean auth(Code) | | Does this service require authorization
|
| contextInfo | | protected Map contextInfo(Code) | | Context Information, a list of parameters used by the service, contains ModelParam objects
|
| contextParamList | | protected List contextParamList(Code) | | Context Information, a list of parameters used by the service, contains ModelParam objects
|
| debug | | public boolean debug(Code) | | Enable verbose debugging when calling this service
|
| defaultEntityName | | public String defaultEntityName(Code) | | The default Entity to use for auto-attributes
|
| description | | public String description(Code) | | The description of this service
|
| engineName | | public String engineName(Code) | | The name of the service engine
|
| export | | public boolean export(Code) | | Can this service be exported via RPC, RMI, SOAP, etc
|
| implServices | | public Set implServices(Code) | | Set of services this service implements
|
| inheritedParameters | | protected boolean inheritedParameters(Code) | | Flag to say if we have pulled in our addition parameters from our implemented service(s)
|
| invoke | | public String invoke(Code) | | The method or function to invoke for this service
|
| location | | public String location(Code) | | The package name or location of this service
|
| nameSpace | | public String nameSpace(Code) | | The namespace of this service
|
| overrideParameters | | public Set overrideParameters(Code) | | Set of override parameters
|
| permissionGroups | | public List permissionGroups(Code) | | List of permission groups for service invocation
|
| requireNewTransaction | | public boolean requireNewTransaction(Code) | | Require a new transaction for this service
|
| transactionTimeout | | public int transactionTimeout(Code) | | Override the default transaction timeout, only works if we start the transaction
|
| useTransaction | | public boolean useTransaction(Code) | | Create a transaction for this service (if one is not already in place...)?
|
| validate | | public boolean validate(Code) | | Validate the context info for this service
|
| ModelService | | public ModelService()(Code) | | |
| addParam | | public void addParam(ModelParam param)(Code) | | Adds a parameter definition to this service; puts on list in order added
then sorts by order if specified.
|
| addParamClone | | public void addParamClone(ModelParam param)(Code) | | Adds a clone of a parameter definition to this service
|
| containsPermissions | | public boolean containsPermissions()(Code) | | |
| evalPermissions | | public boolean evalPermissions(Security security, GenericValue userLogin)(Code) | | Evaluates permissions for a service.
Parameters:
security - The security object to use for permission checking
Parameters:
userLogin - The logged in user's value object true if all permissions evaluate true. |
| getAllParamNames | | public Set getAllParamNames()(Code) | | |
| getInModelParamList | | public List getInModelParamList()(Code) | | Returns a list of ModelParam objects in the order they were defined when
the service was created.
|
| getInParamNames | | public Set getInParamNames()(Code) | | |
| getInParameterSequence | | public List getInParameterSequence(Map source)(Code) | | Gets a list of required IN parameters in sequence.
A list of required IN parameters in the order which they were defined. |
| getModelParamList | | public List getModelParamList()(Code) | | Returns a list of ModelParam objects in the order they were defined when
the service was created.
|
| getOutParamNames | | public Set getOutParamNames()(Code) | | |
| getParam | | public ModelParam getParam(String name)(Code) | | Gets the ModelParam by name
Parameters:
name - The name of the parameter to get ModelParam object with the specified name |
| getParameterNames | | public List getParameterNames(String mode, boolean optional)(Code) | | Gets the parameter names of the specified mode (IN/OUT/INOUT). The
parameters will be returned in the order specified in the file.
Note: IN and OUT will also contains INOUT parameters.
Parameters:
mode - The mode (IN/OUT/INOUT)
Parameters:
optional - True if to include optional parameters List of parameter names |
| inheritedParameters | | public boolean inheritedParameters()(Code) | | Test if we have already inherited our interface parameters
boolean |
| interfaceUpdate | | public synchronized void interfaceUpdate(DispatchContext dctx) throws GenericServiceException(Code) | | Run the interface update and inherit all interface parameters
Parameters:
dctx - The DispatchContext to use for service lookups |
| makeValid | | public Map makeValid(Map source, String mode)(Code) | | Creates a new Map based from an existing map with just valid parameters.
Tries to convert parameters to required type.
Parameters:
source - The source map
Parameters:
mode - The mode which to build the new map |
| makeValid | | public Map makeValid(Map source, String mode, boolean includeInternal)(Code) | | Creates a new Map based from an existing map with just valid parameters.
Tries to convert parameters to required type.
Parameters:
source - The source map
Parameters:
mode - The mode which to build the new map
Parameters:
includeInternal - When false will exclude internal fields |
| validate | | public void validate(Map test, String mode) throws ServiceValidationException(Code) | | Validates a Map against the IN or OUT parameter information
Parameters:
test - The Map object to test
Parameters:
mode - Test either mode IN or mode OUT |
| validate | | public static void validate(Map info, Map test, boolean reverse, ModelService model, String mode) throws ServiceValidationException(Code) | | Validates a map of name, object types to a map of name, objects
Parameters:
info - The map of name, object types
Parameters:
test - The map to test its value types.
Parameters:
reverse - Test the maps in reverse. |
|
|