ClassificationDialog (Alfresco Records Management Automation 2.4.b API)

java.lang.Object
- org.alfresco.po.common.renderable.Renderable
- - org.alfresco.po.common.Dialog
  - - org.alfresco.po.rm.dialog.classification.ClassificationDialog

All Implemented Interfaces:

StandardButtons

Direct Known Subclasses:

ClassifyContentDialog, EditClassifiedContentDialog
```
public abstract class ClassificationDialog
extends Dialog
```
Abstract class for the classification dialog

Since:

2.4.a

Author:

tpage

Field Summary

Fields
Modifier and Type	Field and Description
`String`	`CLASSIFY_BUTTON_LABEL` Labels used in the dialog
`String`	`CLASSIFY_DOCUMENT_TITLE`
`String`	`CLASSIFY_RECORD_TITLE`
`int`	`DECLASSIFICATION_SCHEDULE`
`int`	`DOWNGRADE_SCHEDULE` Dialog tabs indexes
`String`	`EDIT_BUTTON_LABEL`
`String`	`EDIT_DOCUMENT_CLASSIFICATION_TITLE`
`String`	`EDIT_RECORD_CLASSIFICATION_TITLE`

Fields inherited from class org.alfresco.po.common.Dialog
dialog, VISIBLE_DIALOG

Fields inherited from class org.alfresco.po.common.renderable.Renderable
renderableParent, webDriver

Fields inherited from interface org.alfresco.po.common.buttonset.StandardButtons
CANCEL, CONFIRM, DELETE, OK, REQUEST_INFORMATION, SAVE

Constructor Summary

Constructors
Constructor and Description

ClassificationDialog()

Constructors
Constructor and Description
`ClassificationDialog()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`ClassificationDialog`	`addExemptionCategory(String id)` Search for an exemption category then, when the dropdown options are visible, click on the desired category.
`ClassificationDialog`	`addReason(String id)` Search for a classification reason then, when the dropdown options are visible, click on the desired reason.
`ClassificationDialog`	`clearClassifiedByField()` Clear the Classified by field
`ClassificationDialog`	`clearDowngradeDate()` Clear the Downgrade date field
`ClassificationDialog`	`clearDowngradeEvent()` Clear the Downgrade Event field
`ClassificationDialog`	`clearInstructionsField()` Clear the Instructions field
`ClassificationDialog`	`clickDeclassificationScheduleTab()` Click the declassification schedule tab
`Renderable`	`clickOnCancel()` Click on cancel
`Renderable`	`clickOnClassify()` Click on classify
`Renderable`	`clickOnClassifyFromDetailsPage()` Click on Classify from the Details Page
`Renderable`	`clickOnEdit()` Click on edit classification
`Renderable`	`closeDialog()` Close dialog
`String`	`getAgency()`
`List<String>`	`getAvailableLevels()` Open the levels dropdown to find the potential options available to the current user.
`String`	`getClassifiedBy()`
`String`	`getClassifyButtonLabel()`
`String`	`getClassifyDialogTitle()`
`String`	`getDeclassificationDate()`
`String`	`getDeclassificationEvent()`
`String`	`getDowngradeDate()`
`String`	`getDowngradeEvent()`
`String`	`getDowngradeInstructions()`
`String`	`getEditButtonLabel()`
`String`	`getEditClasificationTitle()`
`List<String>`	`getExemptions()`
`String`	`getLevel()`
`protected abstract org.openqa.selenium.WebElement`	`getLevelSelectButton()` Level select button
`protected abstract org.openqa.selenium.WebElement`	`getLevelsMenu()` Levels menu
`List<String>`	`getReasons()`
`protected abstract org.openqa.selenium.WebElement`	`getSelectedLevel()` Selected level
`boolean`	`isClassifyButtonEnabled()`
`boolean`	`isDisplayed()`
`boolean`	`isEditClassificationDialogDisplayed()`
`boolean`	`isInstructionsFieldRequired()`
`boolean`	`isTabSelected(int index)` Check if the tab with the number given as parameter is selected
`boolean`	`isValidationDisplayed(String validationMessage)`
`ClassificationDialog`	`removeSelectedExemption(String index)` Remove a exemption that has previously been selected.
`ClassificationDialog`	`removeSelectedReason(String id)` Remove a reason that has previously been selected.
`void`	`selectTab(Integer index)` Select tab if the tab with the index given as parameter is not already selected
`ClassificationDialog`	`setAgency(String agency)` Set classification agency
`ClassificationDialog`	`setAgencyEmpty()` Set classification agency to empty value
`ClassificationDialog`	`setClassifiedBy(String classifiedBy)` Set classified by
`ClassificationDialog`	`setDeclassificationDate(String declassificationDate)` Set the declassification date.
`ClassificationDialog`	`setDeclassificationEvent(String event)` Set declassification event
`ClassificationDialog`	`setDowngradeDate(String downgradeDate)` Set the downgrade date.
`ClassificationDialog`	`setDowngradeEvent(String event)` Set downgrade event
`ClassificationDialog`	`setDowngradeInstructions(String instructions)` Set downgrade instructions
`ClassificationDialog`	`setInvalidAgency(String text)` Set classification agency to invalid value
`ClassificationDialog`	`setInvalidDeclassificationEvent(String event)` Set invalid declassification event
`ClassificationDialog`	`setInvalidDowngradeEvent(String event)` Set invalid downgrade event
`ClassificationDialog`	`setInvalidDowngradeInstructions(String instructions)` Set invalid downgrade instructions
`protected abstract ClassificationDialog`	`setLevel(String levelId)` Set the classification level.

Methods inherited from class org.alfresco.po.common.renderable.Renderable
as, getAllFields, getLastRendered, render, renderChildren

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - CLASSIFY_BUTTON_LABEL
```
public final String CLASSIFY_BUTTON_LABEL
```
    Labels used in the dialog
    
    See Also:
    
    Constant Field Values
  - EDIT_BUTTON_LABEL
```
public final String EDIT_BUTTON_LABEL
```
    See Also:
    
    Constant Field Values
  - CLASSIFY_RECORD_TITLE
```
public final String CLASSIFY_RECORD_TITLE
```
    See Also:
    
    Constant Field Values
  - CLASSIFY_DOCUMENT_TITLE
```
public final String CLASSIFY_DOCUMENT_TITLE
```
    See Also:
    
    Constant Field Values
  - EDIT_DOCUMENT_CLASSIFICATION_TITLE
```
public final String EDIT_DOCUMENT_CLASSIFICATION_TITLE
```
    See Also:
    
    Constant Field Values
  - EDIT_RECORD_CLASSIFICATION_TITLE
```
public final String EDIT_RECORD_CLASSIFICATION_TITLE
```
    See Also:
    
    Constant Field Values
  - DOWNGRADE_SCHEDULE
```
public final int DOWNGRADE_SCHEDULE
```
    Dialog tabs indexes
    
    See Also:
    
    Constant Field Values
  - DECLASSIFICATION_SCHEDULE
```
public final int DECLASSIFICATION_SCHEDULE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ClassificationDialog
```
public ClassificationDialog()
```
- Method Detail
  - getLevelSelectButton
```
protected abstract org.openqa.selenium.WebElement getLevelSelectButton()
```
    Level select button
  - getSelectedLevel
```
protected abstract org.openqa.selenium.WebElement getSelectedLevel()
```
    Selected level
  - getLevelsMenu
```
protected abstract org.openqa.selenium.WebElement getLevelsMenu()
```
    Levels menu
  - setLevel
```
protected abstract ClassificationDialog setLevel(String levelId)
```
    Set the classification level.
    
    Parameters:
    
    levelId - The label on the classification level dropdown button.
    
    Returns:
    
    The dialog to allow chaining of actions.
  - getLevel
```
public String getLevel()
```
  - getClassifiedBy
```
public String getClassifiedBy()
```
  - getAvailableLevels
```
public List<String> getAvailableLevels()
```
    Open the levels dropdown to find the potential options available to the current user.
    
    Returns:
    
    The list of levels in the order they were found on the page.
  - setAgency
```
public ClassificationDialog setAgency(String agency)
```
    Set classification agency
  - setAgencyEmpty
```
public ClassificationDialog setAgencyEmpty()
```
    Set classification agency to empty value
  - setInvalidAgency
```
public ClassificationDialog setInvalidAgency(String text)
```
    Set classification agency to invalid value
  - setClassifiedBy
```
public ClassificationDialog setClassifiedBy(String classifiedBy)
```
    Set classified by
  - clearClassifiedByField
```
public ClassificationDialog clearClassifiedByField()
```
    Clear the Classified by field
  - clearDowngradeDate
```
public ClassificationDialog clearDowngradeDate()
```
    Clear the Downgrade date field
  - clearDowngradeEvent
```
public ClassificationDialog clearDowngradeEvent()
```
    Clear the Downgrade Event field
  - clearInstructionsField
```
public ClassificationDialog clearInstructionsField()
```
    Clear the Instructions field
  - setDowngradeDate
```
public ClassificationDialog setDowngradeDate(String downgradeDate)
```
    Set the downgrade date.
    
    Parameters:
    
    downgradeDate - A string containing the downgrade date in the current locale. For maximum portability it is recommended to supply a date where the date and month are the same (e.g. "01/01/2016").
    
    Returns:
    
    The dialog to allow chaining.
  - setDowngradeEvent
```
public ClassificationDialog setDowngradeEvent(String event)
```
    Set downgrade event
  - setInvalidDowngradeEvent
```
public ClassificationDialog setInvalidDowngradeEvent(String event)
```
    Set invalid downgrade event
  - setDowngradeInstructions
```
public ClassificationDialog setDowngradeInstructions(String instructions)
```
    Set downgrade instructions
  - setInvalidDowngradeInstructions
```
public ClassificationDialog setInvalidDowngradeInstructions(String instructions)
```
    Set invalid downgrade instructions
  - setDeclassificationDate
```
public ClassificationDialog setDeclassificationDate(String declassificationDate)
```
    Set the declassification date.
    
    Parameters:
    
    declassificationDate - A string containing the declassification date in the current locale. For maximum portability it is recommended to supply a date where the date and month are the same (e.g. "01/01/2016").
    
    Returns:
    
    The dialog to allow chaining.
  - setDeclassificationEvent
```
public ClassificationDialog setDeclassificationEvent(String event)
```
    Set declassification event
  - setInvalidDeclassificationEvent
```
public ClassificationDialog setInvalidDeclassificationEvent(String event)
```
    Set invalid declassification event
  - addReason
```
public ClassificationDialog addReason(String id)
```
    Search for a classification reason then, when the dropdown options are visible, click on the desired reason.
    
    Parameters:
    
    id - The classification reason id (e.g. "3").
    
    Returns:
    
    The dialog to allow chaining of actions.
  - clickDeclassificationScheduleTab
```
public ClassificationDialog clickDeclassificationScheduleTab()
```
    Click the declassification schedule tab
  - addExemptionCategory
```
public ClassificationDialog addExemptionCategory(String id)
```
    Search for an exemption category then, when the dropdown options are visible, click on the desired category.
    
    Parameters:
    
    id - The exemption category id (e.g. "4").
    
    Returns:
    
    The dialog to allow chaining of actions.
  - removeSelectedReason
```
public ClassificationDialog removeSelectedReason(String id)
                                          throws org.openqa.selenium.NoSuchElementException
```
    Remove a reason that has previously been selected.
    
    Parameters:
    
    id - The classification reason id (e.g. "3") - note this is currently not displayed on the page.
    
    Returns:
    
    The dialog to allow chaining of actions.
    
    Throws:
    
    org.openqa.selenium.NoSuchElementException - If the reason with the given id has not been applied to the content.
  - removeSelectedExemption
```
public ClassificationDialog removeSelectedExemption(String index)
                                             throws org.openqa.selenium.NoSuchElementException
```
    Remove a exemption that has previously been selected.
    
    Parameters:
    
    index - The classification exemption index.
    
    Returns:
    
    The dialog to allow chaining of actions.
    
    Throws:
    
    org.openqa.selenium.NoSuchElementException - If the exemption with the given index has not been applied to the content.
  - clickOnClassify
```
public Renderable clickOnClassify()
```
    Click on classify
  - clickOnEdit
```
public Renderable clickOnEdit()
```
    Click on edit classification
  - clickOnClassifyFromDetailsPage
```
public Renderable clickOnClassifyFromDetailsPage()
```
    Click on Classify from the Details Page
  - clickOnCancel
```
public Renderable clickOnCancel()
```
    Click on cancel
  - closeDialog
```
public Renderable closeDialog()
```
    Close dialog
  - isTabSelected
```
public boolean isTabSelected(int index)
```
    Check if the tab with the number given as parameter is selected
  - selectTab
```
public void selectTab(Integer index)
```
    Select tab if the tab with the index given as parameter is not already selected
  - isDisplayed
```
public boolean isDisplayed()
```
    Returns:
    
    true if the Classify Content dialog is visible (actually check if the "create" button is visible).
  - isEditClassificationDialogDisplayed
```
public boolean isEditClassificationDialogDisplayed()
```
    Returns:
    
    true if the Classify Content dialog is visible (actually check if the "create" button is visible).
  - isClassifyButtonEnabled
```
public boolean isClassifyButtonEnabled()
```
    Returns:
    
    true if the classify button is visible and enabled.
  - isInstructionsFieldRequired
```
public boolean isInstructionsFieldRequired()
```
    Returns:
    
    true if the Instructions field is required
  - getAgency
```
public String getAgency()
```
    Returns:
    
    The classification agency entered.
  - getReasons
```
public List<String> getReasons()
```
    Returns:
    
    The list of selected classification reasons.
  - getExemptions
```
public List<String> getExemptions()
```
    Returns:
    
    The list of selected exemptions.
  - getDowngradeDate
```
public String getDowngradeDate()
```
    Returns:
    
    The downgrade date.
  - getDowngradeEvent
```
public String getDowngradeEvent()
```
    Returns:
    
    The downgrade event.
  - getDowngradeInstructions
```
public String getDowngradeInstructions()
```
    Returns:
    
    The downgrade instructions.
  - getDeclassificationDate
```
public String getDeclassificationDate()
```
    Returns:
    
    The declassification date.
  - getDeclassificationEvent
```
public String getDeclassificationEvent()
```
    Returns:
    
    The declassification event.
  - getClassifyDialogTitle
```
public String getClassifyDialogTitle()
```
    Returns:
    
    The Classify content dialog title.
  - getEditClasificationTitle
```
public String getEditClasificationTitle()
```
    Returns:
    
    The Edit Classification dialog title.
  - getEditButtonLabel
```
public String getEditButtonLabel()
```
    Returns:
    
    the Edit classification button label
  - getClassifyButtonLabel
```
public String getClassifyButtonLabel()
```
    Returns:
    
    the Classify button label
  - isValidationDisplayed
```
public boolean isValidationDisplayed(String validationMessage)
```

Class ClassificationDialog

Field Summary

Fields inherited from class org.alfresco.po.common.Dialog

Fields inherited from class org.alfresco.po.common.renderable.Renderable

Fields inherited from interface org.alfresco.po.common.buttonset.StandardButtons

Constructor Summary

Method Summary

Methods inherited from class org.alfresco.po.common.renderable.Renderable

Methods inherited from class java.lang.Object

Field Detail

CLASSIFY_BUTTON_LABEL

EDIT_BUTTON_LABEL

CLASSIFY_RECORD_TITLE

CLASSIFY_DOCUMENT_TITLE

EDIT_DOCUMENT_CLASSIFICATION_TITLE

EDIT_RECORD_CLASSIFICATION_TITLE

DOWNGRADE_SCHEDULE

DECLASSIFICATION_SCHEDULE

Constructor Detail

ClassificationDialog

Method Detail

getLevelSelectButton

getSelectedLevel

getLevelsMenu

setLevel

getLevel

getClassifiedBy

getAvailableLevels

setAgency

setAgencyEmpty

setInvalidAgency

setClassifiedBy

clearClassifiedByField

clearDowngradeDate

clearDowngradeEvent

clearInstructionsField

setDowngradeDate

setDowngradeEvent

setInvalidDowngradeEvent

setDowngradeInstructions

setInvalidDowngradeInstructions

setDeclassificationDate

setDeclassificationEvent

setInvalidDeclassificationEvent

addReason

clickDeclassificationScheduleTab

addExemptionCategory

removeSelectedReason

removeSelectedExemption

clickOnClassify

clickOnEdit

clickOnClassifyFromDetailsPage

clickOnCancel

closeDialog

isTabSelected

selectTab

isDisplayed

isEditClassificationDialogDisplayed

isClassifyButtonEnabled

isInstructionsFieldRequired

getAgency

getReasons

getExemptions

getDowngradeDate

getDowngradeEvent

getDowngradeInstructions

getDeclassificationDate

getDeclassificationEvent

getClassifyDialogTitle

getEditClasificationTitle

getEditButtonLabel

getClassifyButtonLabel

isValidationDisplayed