com.tszadel.qctools4j.clients
Class FieldDescriptionClient

java.lang.Object
  com.tszadel.qctools4j.clients.AbstractClient
      com.tszadel.qctools4j.clients.FieldDescriptionClient

public class FieldDescriptionClient
extends AbstractClient

The client manages the permissions.

Author:

tszadel

Field Summary

Fields inherited from class com.tszadel.qctools4j.clients.AbstractClient

connection, NONE, WITH_ATTACHMENTS, WITH_CHILDREN

Method Summary

Map<String,FieldDescription>	getFieldDescriptions() Overrides getFieldDescriptions.
Map<String,FieldDescription>	getFieldDescriptions(Class<? extends IQcModel> pClass) Returns the field descriptions for the given class.

Methods inherited from class com.tszadel.qctools4j.clients.AbstractClient

canExecuteAction, checkConnection, checkLogin, checkPermission, containsFlag, getEncodedString, loadFields, retrieveAttachments, retrieveCustomFields, storeAttachments, storeFields, toAttachment

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getFieldDescriptions

public Map<String,FieldDescription> getFieldDescriptions()
                                                  throws QcException

Overrides getFieldDescriptions. Returns the descriptions of the fields.

Specified by:

getFieldDescriptions in class AbstractClient

Returns:

The description of the fields (key=name of the field, value=description of the field).

Throws:

QcException - Qc Error.

See Also:

AbstractClient.getFieldDescriptions()

getFieldDescriptions

public Map<String,FieldDescription> getFieldDescriptions(Class<? extends IQcModel> pClass)
                                                  throws QcException

Returns the field descriptions for the given class.

Parameters:

pClass - The class.

Returns:

The field description (the key is the name of the field).

Throws:

QcException - Qc Error.