Convenios de denominación

Cada interfaz derivada de la interfaz Resource dispone de un conjunto bien definido de propiedades que la API de ClearQuest CM puede examinar y modificar. Cada interfaz también cuenta con un conjunto bien definido de operaciones que se pueden invocar en el proxy para que el recurso subyacente resulte afectado. Los métodos de proxy cuyos nombres empiezan por get, set y do realizan operaciones específicas.
Cualquier método proxy cuyo nombres empiece por:

Los métodos que obtienen y establecen propiedades no interactúan con el recurso. Los métodos set almacenan sus valores de argumento en el proxy y los métodos get recuperan los valores de propiedad ya almacenados en el proxy. Los valores se leen desde un repositorio mediante un método do como, por ejemplo Resource.doReadProperties() y se graban en un repositorio mediante un método do como, por ejemplo, doWriteProperties().

Los métodos do hacen que el proveedor de la API lleve a cabo operaciones en el recurso y que se interactúe con el servidor. Muchos métodos do utilizan un parámetro ProperyRequest o Feedback opcional en el que el cliente puede solicitar las propiedades que deben leerse desde el recurso al ejecutar dicho método. Todos los métodos do graban en el recurso real todos los valores de propiedad que se han establecido en el proxy desde la última interacción del servidor.

El nombre de cada interfaz de cada paquete de la API de ClearQuest CM es exclusivo e incluye un prefijo que identifica el paquete que lo contiene. De este modo, es fácil leer código aunque no utilice nombres de interfaz completos.


Comentarios