Convenções de Nomenclatura

Cada interface derivada de uma interface Resource possui um conjunto bem definido de propriedades que podem ser examinadas e modificadas pelo ClearQuest CM API. Cada interface também possui um conjunto bem definido de operações que podem ser chamadas no proxy para colocar em vigor o recurso subjacente. Os métodos de proxy cujos nomes começam com get, set e do executam operações específicas.
Qualquer método de proxy cujo nome comece com:

Os métodos que obtêm (get) e configuram (set) as propriedades não interagem com o recurso. Os métodos set armazenam seus valores de argumento no proxy e os métodos get recuperam os valores de propriedade armazenados no proxy. Os valores são lidos a partir de um repositório usando um método do como o Resource.doReadProperties() e são gravados para um repositório usando um método do como o doWriteProperties().

Os métodos do fazem com que o Provedor da API execute operações no recurso e causem uma interação com o servidor. Muitos dos métodos do tomam um parâmetro opcional ProperyRequest ou Feedback no qual o cliente pode solicitar as propriedades a serem lidas a partir do recurso ao executar esse método. Todos os métodos do gravam para o recurso quaisquer valores de propriedades que tenham sido configurados no proxy desde a última interação com o servidor.

O nome de cada interface em cada pacote do ClearQuest CM API é exclusivo e inclui um prefixo que identifica o pacote que o contém. Isso facilita a leitura do código, mesmo quando não estão sendo usados nomes completos da interface.


Feedback